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 70fcc8afed..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,29 +122,7 @@ ] }, "monikerPath": [ - "mapping/monikerMapping.json" - ] - }, - { - "docset_name": "spmt-ps", - "build_source_folder": "spmt", - "build_output_subfolder": "spmt-ps", - "locale": "en-us", - "monikers": [], - "moniker_ranges": [], - "open_to_public_contributors": true, - "type_mapping": { - "Conceptual": "Content", - "ManagedReference": "Content", - "RestApi": "Content", - "PowershellModule": "Content", - "PowershellCmdlet": "Content" - }, - "build_entry_point": "docs", - "template_folder": "_themes", - "version": 0, - "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] }, { @@ -187,7 +149,7 @@ ] }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] } ], @@ -195,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", @@ -212,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": [ { @@ -227,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 1955f46eb4..0c2327fa83 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -312,7 +312,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/get-phishfilterpolicy", + "redirect_url": "/powershell/module/exchange/get-tenantallowblocklistspoofitems", "redirect_document_id": false }, { @@ -422,7 +422,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-PhishFilterPolicy.md", - "redirect_url": "/powershell/module/exchange/set-phishfilterpolicy", + "redirect_url": "/powershell/module/exchange/set-tenantallowblocklistspoofitems", "redirect_document_id": false }, { @@ -1977,7 +1977,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/get-rmstrustedpublishingdomain", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { @@ -1992,7 +1992,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Import-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/import-rmstrustedpublishingdomain", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { @@ -2022,7 +2022,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/remove-rmstrustedpublishingdomain", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { @@ -2052,7 +2052,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-RMSTrustedPublishingDomain.md", - "redirect_url": "/powershell/module/exchange/set-rmstrustedpublishingdomain", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { @@ -3152,7 +3152,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Import-ContactList.md", - "redirect_url": "/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 }, { @@ -5142,72 +5142,72 @@ }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-ConnectionByClientTypeDetailReport.md", - "redirect_url": "/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": "/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": "/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": "/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": "/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": "/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": "/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": "/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": "/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": "/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": "/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": "/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": "/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": "/powershell/module/exchange/get-groupactivityreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { @@ -5217,7 +5217,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-LicenseVsUsageSummaryReport.md", - "redirect_url": "/powershell/module/exchange/get-licensevsusagesummaryreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { @@ -5227,17 +5227,17 @@ }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailboxActivityReport.md", - "redirect_url": "/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": "/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": "/powershell/module/exchange/get-mailboxusagereport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { @@ -5282,7 +5282,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficTopReport.md", - "redirect_url": "/powershell/module/exchange/get-mailtraffictopreport", + "redirect_url": "/powershell/module/exchange/get-mailtrafficsummaryreport", "redirect_document_id": false }, { @@ -5292,22 +5292,22 @@ }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientBrowserDetailReport.md", - "redirect_url": "/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": "/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": "/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": "/powershell/module/exchange/get-o365clientosreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { @@ -5337,42 +5337,42 @@ }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOActiveUserReport.md", - "redirect_url": "/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": "/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": "/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": "/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": "/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": "/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": "/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": "/powershell/module/exchange/get-stalemailboxreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { @@ -6347,12 +6347,12 @@ }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-EOPDistributionGroup.md", - "redirect_url": "/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": "/powershell/module/exchange/new-eopmailuser", + "redirect_url": "/powershell/module/exchange/new-mailuser", "redirect_document_id": false }, { @@ -6387,12 +6387,12 @@ }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-EOPDistributionGroup.md", - "redirect_url": "/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": "/powershell/module/exchange/remove-eopmailuser", + "redirect_url": "/powershell/module/exchange/remove-mailuser", "redirect_document_id": false }, { @@ -6432,22 +6432,22 @@ }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPDistributionGroup.md", - "redirect_url": "/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": "/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": "/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": "/powershell/module/exchange/set-eopuser", + "redirect_url": "/powershell/module/exchange/set-user", "redirect_document_id": false }, { @@ -6492,7 +6492,7 @@ }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Update-EOPDistributionGroupMember.md", - "redirect_url": "/powershell/module/exchange/update-eopdistributiongroupmember", + "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", "redirect_document_id": false }, { @@ -6547,8 +6547,8 @@ }, { "source_path": "exchange/docs-conceptual/exchange-server/use-update-exchangehelp.md", - "redirect_url": "/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", @@ -6839,6 +6839,2188 @@ "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 4d5673c37e..799d11a6c6 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,92 @@ +--- +ms.date: 05/16/2025 +--- + # Overview ## Learn how to contribute -Anyone who is interested can contribute to the topics. When you contribute, your work will go directly into the content set after being merged. It will then be published to [Microsoft Learn](https://learn.microsoft.com/) and you will be listed as a contributor at: . +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: . + +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 -Contributors who only make infrequent or small updates can edit the file directly on GitHub.com without having to install any additional software. This article shows you how. [This two-minute video](https://www.microsoft.com/videoplayer/embed/RE1XQTG) also covers how to contribute. +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. + +> [!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. + +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**. + + ![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) + +4. The corresponding article file opens on GitHub. Select ![Edit icon.](images/quick-update-github-edit-icon.png) **Edit**. + + ![Screenshot of how to select the Edit button on a GitHub article file.](images/quick-update-edit-button-on-github-page.png) + +5. If a **You need to fork this repository to propose changes** page opens, select **Fork this repository**. + + ![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) -1. Make sure you're signed in to GitHub.com with your GitHub account. -2. Browse to the page you want to edit on Microsoft Learn. -3. On the right-hand side of the page, click **Edit** (pencil icon). +6. The article file opens in a line-numbered editor page where you can make updates. - ![Edit button on Microsoft Learn.](https://learn.microsoft.com/compliance/media/quick-update-edit.png) + 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/). -4. The corresponding topic file on GitHub opens, where you need to click the **Edit this file** pencil icon. + > [!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). - ![Edit button on github.com.](https://learn.microsoft.com/compliance/media/quick-update-github.png) + Select **Preview** to view your changes as you go. Select **Edit** to go back to making updates. -5. The topic opens in a line-numbered editing page where you can make changes to the file. 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/). Select the **Preview changes** tab to view your changes as you go. + When you're finished making changes, select the green **Commit changes** button. -6. When you're finished making changes, go to the **Propose file change** section at the bottom of the page: + ![Screenshot of how to select the green Commit changes button on the article editor page.](images/quick-update-editor-page.png) - - 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. +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. - When you're ready, click the green **Propose file change** button. + When you're finished on the **Propose changes** dialog, select the green **Propose changes** button. - ![Propose file change section.](https://learn.microsoft.com/compliance/media/propose-file-change.png) + ![Screenshot of how to select the green Propose changes button in the Propose changes dialog.](images/quick-update-propose-changes-dialog.png) -7. On the **Comparing changes** page that appears, click the green **Create pull request** button. +8. On the **Comparing changes** page that opens, select the green **Create pull request** button. - ![Comparing changes page.](https://learn.microsoft.com/compliance/media/comparing-changes-page.png) + ![Screenshot of how to select the green Create pull request button on the Comparing changes page.](images/quick-update-comparing-changes-page.png) -8. On the **Open a pull request** page that appears, click the green **Create pull request** button. +9. On the **Open a pull request** page that opens, review the title and comments, and then select the green **Create pull request** button. - ![Open a pull request page.](https://learn.microsoft.com/compliance/media/open-a-pull-request-page.png) + ![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) -> [!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. +10. That's it. There's nothing more for you to do. -The writer identified in the metadata of the topic will be notified and will eventually review and approve your changes so the topic will be updated on Microsoft Learn. If there are questions or issues with the updates, the writer will contact you. + 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 . -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 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. +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 do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at . +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/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 28188cb361..f23758f7ff 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -2,8 +2,8 @@ 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 @@ -14,14 +14,14 @@ ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Learn about using the Exchange Online PowerShell V2 module and V3 module in scripts and other long-running tasks with modern authentication and app-only authentication (also known a certificate based authentication or CBA)." +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 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 is not a good security practice. +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 Azure AD apps and self-signed certificates. +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] > @@ -29,30 +29,34 @@ Certificate based authentication (CBA) or app-only authentication as described i > > - 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). > -> - Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 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 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) +> - 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. > -> - Delegated scenarios are supported in **Exchange Online** using multi-tenant applications. The required steps are called out within the regular instructions in this article. +> - Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet if you get the following error when using the Windows PowerShell SDK to connect: `The term 'Update-ModuleManifest' is not recognized as a name of a cmdlet, function, script file, or executable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again.` ## How does it work? -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 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. +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. ## Connection examples @@ -63,20 +67,19 @@ The following examples show how to use the Exchange Online PowerShell module wit > > 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: > -> - In Exchange Online PowerShell using the EXO V3 module, you can omit or include the _UseRPSSession_ switch to use REST API cmdlets or original remote PowerShell cmdlets. For more information, see [Updates for version 3.0.0 (the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module). -> -> Remote PowerShell support in Exchange Online PowerShell will be deprecated. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). -> > - 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 present a login prompt, run the command: `$Global:IsWindows = $true` before the **Connect-IPPSSession** command. +> - If a **Connect-IPPSSession** command presents a login prompt, run the command: `$Global:IsWindows = $true` before the **Connect-IPPSSession** command. - **Connect using a certificate thumbprint**: + > [!NOTE] + > The CertificateThumbprint parameter is supported only in Microsoft Windows. + 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: @@ -93,7 +96,7 @@ The following examples show how to use the Exchange Online PowerShell module wit - **Connect using a certificate object**: - The certificate does not 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. + 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: @@ -126,47 +129,47 @@ The following examples show how to use the Exchange Online PowerShell module wit ## 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. -### 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. +> 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. -1. Open the Azure AD portal at . +1. Open the Microsoft Entra admin center at . 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. ![Screenshot that shows App registrations in the Search results on the home page of the Azure portal.](media/exo-app-only-auth-find-app-registrations.png) - Or, to go directly to the **App registrations** page, use . + Or, to go directly to the **App registrations** page, use . -3. On the **App registrations** page, 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) @@ -177,70 +180,153 @@ For a detailed visual flow about creating applications in Azure AD, see only - Single tenant)** is selected. > [!NOTE] - > To make the application multi-tenant for **Exchange Online** delegated scenarios, select the value **Accounts in any organizational directory (Any Azure AD directory - Multitenant)**. + > To make the application multi-tenant for **Exchange Online** delegated scenarios, select the value **Accounts in any organizational directory (Any Microsoft Entra directory - Multitenant)**. - - **Redirect URI (optional)**: In the first box, verify that **Web** is selected. In the second box, enter the URI where the access token is sent. + - **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](/azure/active-directory/manage-apps/application-proxy-configure-native-client-application), because you can't use that type for automated applications. + > 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**. -4. 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 -> [!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. + + ![Find and select Office 365 Exchange Online on the APIs my organization uses tab.](media/exo-app-only-auth-api-permissions-select-o365-exo.png) + +4. On the **What type of permissions does your application require?** flyout that appears, select **Application permissions**. + +5. In the permissions list that appears, expand **Exchange**, select **Exchange.ManageAsApp**, and then select **Add permissions**. + + ![Find and select Exchange.ManageAsApp permissions from the Application permission tab.](media/exo-app-only-auth-api-permissions-select-exchange-manageasapp.png) + +6. Back on the app **API permissions** page, verify **Office 365 Exchange Online** \> **Exchange.ManageAsApp** is listed and contains the following values: + - **Type**: **Application**. + - **Admin consent required**: **Yes**. + + - **Status**: The current incorrect value is **Not granted for \**. -1. On the app page under **Management**, select **Manifest**. + Change this value by selecting **Grant admin consent for \**, reading the confirmation dialog that opens, and then selecting **Yes**. - ![Select Manifest on the application properties page.](media/exo-app-only-auth-select-manifest.png) + ![Admin consent required but not granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-original-permissions.png) -2. On the **Manifest** page that opens, find the `requiredResourceAccess` entry (on or about line 47). + The **Status** value is now **Granted for \**. - Modify the `resourceAppId`, `resourceAccess id`, and `resourceAccess type` values as shown in the following code snippet: + ![Admin consent granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-admin-consent-granted.png) + +7. For the default **Microsoft Graph** \> **User.Read** entry, select **...** \> **Revoke admin consent**, and then select **Yes** in the confirmation dialog that opens to return **Status** back to the default blank value. + + ![Admin consent removed from default Microsoft Graph User.Read permissions.](media/exo-app-only-auth-admin-consent-removed-from-graph.png) + +8. Close the current **API permissions** page (not the browser tab) to return to the **App registrations** page. You use the **App registrations** page in an upcoming step. + +#### Modify the app manifest to assign API permissions + +> [!NOTE] +> The procedures in this section _append_ the existing default permissions on the app (delegated **User.Read** permissions in **Microsoft Graph**) with the required application **Exchange.ManageAsApp** permissions in **Office 365 Exchange Online**. + +1. On the app **Overview** page, select **Manifest** from the **Manage** section. + + ![Select Manifest on the application overview page.](media/exo-app-only-auth-select-manifest.png) + +2. On the app **Manifest** page, find the `requiredResourceAccess` entry (on or about line 42), and make the entry look like the following code snippet: ```json "requiredResourceAccess": [ - { - "resourceAppId": "00000002-0000-0ff1-ce00-000000000000", - "resourceAccess": [ - { - "id": "dc50a0fb-09a3-484d-be87-e023b12c6440", - "type": "Role" - } - ] - } + { + "resourceAppId": "00000002-0000-0ff1-ce00-000000000000", + "resourceAccess": [ + { + "id": "dc50a0fb-09a3-484d-be87-e023b12c6440", + "type": "Role" + } + ] + }, + { + "resourceAppId": "00000003-0000-0000-c000-000000000000", + "resourceAccess": [ + { + "id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d", + "type": "Scope" + } + ] + } ], ``` - When you're finished, click **Save**. + > [!NOTE] + > Microsoft 365 GCC High or DoD environments have access to Security & Compliance PowerShell only. Use the following values for the `requiredResourceAccess` entry: + > + > ```json + > "requiredResourceAccess": [ + > { + > "resourceAppId": "00000007-0000-0ff1-ce00-000000000000", + > "resourceAccess": [ + > { + > "id": "455e5cd2-84e8-4751-8344-5672145dfa17", + > "type": "Role" + > } + > ] + > }, + > { + > "resourceAppId": "00000003-0000-0000-c000-000000000000", + > "resourceAccess": [ + > { + > "id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d", + > "type": "Scope" + > } + > ] + > } + > ], + > ``` -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. - - **Status**: The current incorrect value is **Not granted for \**, and this value needs to be changed. + Change the **Status** value by selecting **Grant admin consent for \**, reading the confirmation dialog that opens, and then selecting **Yes**. - ![Original incorrect API permissions.](media/exo-app-only-auth-original-permissions.png) + ![Admin consent required but not granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-original-permissions.png) - Select **Grant admin consent for \**, read the confirmation dialog that opens, and then click **Yes**. + The **Status** value is now **Granted for \**. - The **Status** value should now be **Granted for \**. + ![Admin consent granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-admin-consent-granted.png) - ![Admin consent granted.](media/exo-app-only-auth-admin-consent-granted.png) +5. For the default **Microsoft Graph** \> **User.Read** entry, select **...** \> **Revoke admin consent**, and then select **Yes** in the confirmation dialog that opens to return **Status** back to the default blank value. -4. Close the current **API permissions** page (not the browser tab) to return to the **App registrations** page. You'll use it in an upcoming step. + ![Admin consent removed from default Microsoft Graph User.Read permissions.](media/exo-app-only-auth-admin-consent-removed-from-graph.png) + +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 @@ -265,7 +351,7 @@ 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. @@ -275,19 +361,19 @@ After you register the certificate with your application, you can use the privat ![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. @@ -297,7 +383,7 @@ After you register the certificate with your application, you can use the privat ### 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-azure-ad), 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: +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` @@ -305,52 +391,54 @@ If you made the application multi-tenant for **Exchange Online** delegated scena - `` 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](/azure/active-directory/develop/v2-admin-consent#request-the-permissions-from-a-directory-admin). +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 Azure AD roles to the application +### Step 5: Assign Microsoft Entra roles to the application You have two options: -- **Assign Azure AD roles to the application**: This method is supported in Exchange Online PowerShell and Security & Compliance PowerShell. -- **Assign custom Exchange Online role groups to the application**: Currently, this method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). +- **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 Azure AD roles for the "Exchange Recipient Administrator" role and also assign your custom RBAC role to extend the permissions. +> 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. -#### Assign Azure AD roles to the application +#### Assign Microsoft Entra roles to the application -The supported Azure AD roles are described in the following table: +The supported Microsoft Entra roles are described in the following table: |Role|Exchange Online
PowerShell|Security & Compliance
PowerShell| |---|:---:|:---:| -|[Compliance Administrator](/azure/active-directory/roles/permissions-reference#compliance-administrator)|✔|✔| -|[Exchange Administrator](/azure/active-directory/roles/permissions-reference#exchange-administrator)\*|✔|| -|[Exchange Recipient Administrator](/azure/active-directory/roles/permissions-reference#exchange-recipient-administrator)|✔|| -|[Global Administrator](/azure/active-directory/roles/permissions-reference#global-administrator)\*|✔|✔| -|[Global Reader](/azure/active-directory/roles/permissions-reference#global-reader)|✔|✔| -|[Helpdesk Administrator](/azure/active-directory/roles/permissions-reference#helpdesk-administrator)|✔|| -|[Security Administrator](/azure/active-directory/roles/permissions-reference#security-administrator)\*|✔|✔| -|[Security Reader](/azure/active-directory/roles/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. +|[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. -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). +The Security Administrator role does not have the necessary permissions for those same tasks. + +² Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +For general instructions about assigning roles in Microsoft Entra ID, see [Assign Microsoft Entra roles to users](/entra/identity/role-based-access-control/manage-roles-portal). > [!NOTE] > The following steps are slightly different for Exchange Online PowerShell vs. Security & Compliance PowerShell. The steps for both environments are shown. To configure roles for both environments, repeat the steps in this section. -1. In Azure AD portal at , start typing **roles and administrators** in the **Search** box at the top of the page, and then select **Azure AD roles and administrators** from the results in the **Services** section. +1. In Microsoft Entra admin center at , start typing **roles and administrators** in the **Search** box at the top of the page, and then select **Microsoft Entra roles and administrators** from the results in the **Services** section. - ![Screenshot that shows Azure AD 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) + ![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 **Azure AD roles and administrators** page, use . + Or, to go directly to the **Microsoft Entra roles and administrators** page, use . 2. On the **Roles and administrators** page that opens, find and select one of the supported roles by _clicking on the name of the role_ (not the check box) in the results. @@ -362,7 +450,7 @@ For general instructions about assigning roles in Azure AD, see [View and assign ![Find and select a supported Security & Compliance PowerShell role by clicking on the role name.](media/exo-app-only-auth-find-and-select-supported-role-scc.png) -3. On the **Assignments** page that opens, click **Add assignments**. +3. On the **Assignments** page that opens, select **Add assignments**. - **Exchange Online PowerShell**: @@ -372,11 +460,11 @@ 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) -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-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**. 5. Back on the **Assignments** page, verify that the role has been assigned to the app. @@ -388,35 +476,41 @@ For general instructions about assigning roles in Azure AD, see [View and assign ![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 Exchange Online role groups to the application +#### Assign custom role groups to the application using service principals > [!NOTE] -> Remember, this method is supported only in Exchange Online PowerShell, and only when you connect in [REST API mode](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module) (don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command). +> 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](/exchange/permissions-exo/role-groups#create-role-groups). The custom role group that you assign to the application can contain any combination of built-in and custom roles. +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 Exchange Online role groups to the application, do the following steps: +To assign custom role groups to the application using service principals, do the following steps: -1. In [Azure Active Directory PowerShell for Graph](/powershell/azure/active-directory/install-adv2), run the following command to store the details of the Azure application that you registered in [Step 1](#step-1-register-the-application-in-azure-ad) in a variable: +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 - $ = Get-AzureADServicePrincipal -SearchString "" + Connect-MgGraph -Scopes AppRoleAssignment.ReadWrite.All,Application.Read.All + + $ = Get-MgServicePrincipal -Filter "DisplayName eq ''" ``` For example: ```powershell - $AADApp = Get-AzureADServicePrincipal -SearchString "ExO PowerShell CBA" + 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-AzureADServicePrincipal](/powershell/module/azuread/get-azureadserviceprincipal). + 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) and run the following commands to: - - Create an Exchange Online service principal object for the Azure application. - - Store the details of the service principal in a variable. +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 -ServiceId $.ObjectId -DisplayName "" + New-ServicePrincipal -AppId $.AppId -ObjectId $.Id -DisplayName "" $ = Get-ServicePrincipal -Identity "" ``` @@ -424,17 +518,17 @@ To assign custom Exchange Online role groups to the application, do the followin For example: ```powershell - New-ServicePrincipal -AppId $AADApp.AppId -ServiceId $AADApp.ObjectId -DisplayName "SP for Azure App ExO PowerShell CBA" + New-ServicePrincipal -AppId $AzureADApp.AppId -ObjectId $AzureADApp.Id -DisplayName "SP for Azure AD App ExO PowerShell CBA" - $SP = Get-ServicePrincipal -Identity "SP for Azure 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, run the following command to add the service principal as a member of the custom role group: +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 | $.ServiceId | $.Id> + Add-RoleGroupMember -Identity "" -Member <$.Identity | $.ObjectId | $.Id> ``` For example: 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 a17918f980..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-september/ba-p/3609437) due to the security concerns around Basic authentication. Instead, you should use the [Exchange Online PowerShell module](exchange-online-powershell-v2.md) 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 ea6bc5c724..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-september/ba-p/3609437) due to the security concerns around Basic authentication. Instead, you should use the [Exchange Online PowerShell module](exchange-online-powershell-v2.md) to connect to Exchange Online PowerShell. If you're using PowerShell for administration, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). If you're using PowerShell for automation, see [App-only authentication for unattended scripts](app-only-auth-powershell-v2.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 8184a79c61..0000000000 --- a/exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md +++ /dev/null @@ -1,151 +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-september/ba-p/3609437) due to the security concerns around Basic authentication. Instead, you should use the [Exchange Online PowerShell module](exchange-online-powershell-v2.md) to connect to Security & Compliance PowerShell. If you're using PowerShell for administration, see [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). If you're using PowerShell for automation, see [App-only authentication for unattended scripts](app-only-auth-powershell-v2.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 module to connect to Security & Compliance PowerShell. For instructions, see [Connect to Security & Compliance PowerShell](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/mdo-portal-permissions) 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 589973cb3e..bbd2cf89d9 100644 --- a/exchange/docs-conceptual/cmdlet-property-sets.md +++ b/exchange/docs-conceptual/cmdlet-property-sets.md @@ -2,8 +2,8 @@ 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 @@ -23,8 +23,8 @@ This article describes the property sets that are available in the nine exclusiv For more information about filtering with cmdlets in the module, see [Filters in the Exchange Online PowerShell module](filters-v2.md). -> [!NOTE] -> Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 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). ## 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 index fb2329cbd8..2f484fd336 100644 --- a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md +++ b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md @@ -2,8 +2,8 @@ title: Use Azure managed identities to connect to Exchange Online PowerShell ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 8/24/2023 ms.audience: Admin audience: Admin ms.topic: article @@ -19,7 +19,7 @@ description: "Learn about using the Exchange Online PowerShell V3 module and Azu # Use Azure managed identities to connect to Exchange Online PowerShell -Using the [Exchange Online PowerShell V3 module](exchange-online-powershell-v2.md#updates-for-version-300-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?](/azure/active-directory/managed-identities-azure-resources/overview). +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). @@ -30,11 +30,12 @@ The rest of this article explains how to connect using managed identity, and the > > - [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 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 @@ -55,7 +56,7 @@ The rest of this section explains how to connect using supported Azure resources - 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 Azure AD roles to the managed identity](#step-5-assign-azure-ad-roles-to-the-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 @@ -78,7 +79,7 @@ After you've successfully created, saved, and published the PowerShell runbook, 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, click **Start**. +4. On the details page of the runbook, select **Start**. ### Connect to Exchange Online PowerShell using Azure VMs with system-assigned managed identity @@ -93,17 +94,17 @@ Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com 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 +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). +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 Azure AD roles to the managed identity](#step-6-assign-azure-ad-roles-to-the-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 @@ -128,14 +129,14 @@ After you've successfully created the PowerShell runbook, do the following steps 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, click **Start**. +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").PrincipalId +$MI_ID = (Get-AzUserAssignedIdentity -Name "ContosoMI1" -ResourceGroupName "ContosoRG2").ClientId Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com -ManagedIdentityAccountId $MI_ID ``` @@ -148,7 +149,7 @@ The steps are: 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 Azure AD roles to the managed identity](#step-5-assign-azure-ad-roles-to-the-managed-identity) +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). @@ -216,9 +217,9 @@ To create the Automation account with system-assigned managed identity in [Azure For instructions, see the following articles: -- [System-assigned managed identity in the Azure portal](/azure/active-directory/managed-identities-azure-resources/qs-configure-portal-windows-vm#system-assigned-managed-identity) +- [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](/azure/active-directory/managed-identities-azure-resources/qs-configure-powershell-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 @@ -236,23 +237,26 @@ $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.automation/get-azadserviceprincipal). +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, click ![Add module icon.](media/add-icon.png) **Add a module**. +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, click **Select** to return to the **Add a module** page. + 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, click **Import**. + 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) @@ -261,17 +265,18 @@ For detailed syntax and parameter information, see [Get-AzADServicePrincipal](/p 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/3.0.0 +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.0.0 +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: @@ -298,7 +303,15 @@ The procedures in this step require the Microsoft Graph PowerShell SDK. For inst Connect-MgGraph -Scopes AppRoleAssignment.ReadWrite.All,Application.Read.All ``` -2. If a **Permissions requested** dialog opens, select **Consent on behalf of your organization**, and then click **Accept**. + 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: @@ -312,52 +325,78 @@ The procedures in this step require the Microsoft Graph PowerShell SDK. For inst - `$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 Azure Active Directory. The Id value is different 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). +- [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) -### Step 5: Assign Azure AD roles to the managed identity +#### What to do if the Office 365 Exchange Online resource is not available in Microsoft Entra ID -The supported Azure AD roles are described in the following list: +If the following command returns no results: -- [Compliance Administrator](/azure/active-directory/roles/permissions-reference#compliance-administrator) -- [Exchange Administrator](/azure/active-directory/roles/permissions-reference#exchange-administrator)\* -- [Exchange Recipient Administrator](/azure/active-directory/roles/permissions-reference#exchange-recipient-administrator) -- [Global Administrator](/azure/active-directory/roles/permissions-reference#global-administrator)\* -- [Global Reader](/azure/active-directory/roles/permissions-reference#global-reader) -- [Helpdesk Administrator](/azure/active-directory/roles/permissions-reference#helpdesk-administrator) -- [Security Administrator](/azure/active-directory/roles/permissions-reference#security-administrator)\* -- [Security Reader](/azure/active-directory/roles/permissions-reference#security-reader) +```powershell +Get-MgServicePrincipal -Filter "AppId eq '00000002-0000-0ff1-ce00-000000000000'" +``` -> \* 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. +Do the following steps: -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). +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). -1. In Azure AD portal at , start typing **roles and administrators** in the **Search** box at the top of the page, and then select **Azure AD roles and administrators** from the results in the **Services** section. +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. - ![Screenshot that shows Azure AD 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) +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 +``` - Or, to go directly to the **Azure AD roles and administrators** page, use . +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, click **Add assignments**. +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, click **Add**. + When you're finished, select **Add**. 5. Back on the **Assignments** page, verify that the role has been assigned to the managed identity. @@ -369,31 +408,31 @@ To assign a role to the managed identity in Microsoft Graph PowerShell, do the f Connect-MgGraph -Scopes RoleManagement.ReadWrite.Directory ``` -2. If a **Permissions requested** dialog opens, select **Consent on behalf of your organization**, and then click **Accept**. + If a **Permissions requested** dialog opens, select **Consent on behalf of your organization**, and then click **Accept**. -3. Use the following syntax to assign the required Azure AD role to the managed identity: +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 Azure AD role as listed earlier in this section. + - \ 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.applications/new-mgrolemanagementdirectoryroleassignment) +- [New-MgRoleManagementDirectoryRoleAssignment](/powershell/module/microsoft.graph.identity.governance/new-mgrolemanagementdirectoryroleassignment) ## Create and configure a user-assigned managed identity @@ -402,9 +441,9 @@ 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. [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) +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 Azure AD roles to the managed identity](#step-6-assign-azure-ad-roles-to-the-managed-identity) +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). @@ -412,7 +451,7 @@ After you complete the steps, you're ready to [Connect to Exchange Online PowerS 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](/azure/active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities?pivots=identity-mi-methods-azp#create-a-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: @@ -510,15 +549,15 @@ To create the Automation account with user-assigned managed identity in [Azure P For instructions, see the following articles: -- [User-assigned managed identity in the Azure portal](/azure/active-directory/managed-identities-azure-resources/qs-configure-portal-windows-vm#user-assigned-managed-identity) -- [User-assigned managed identity in PowerShell](/azure/active-directory/managed-identities-azure-resources/qs-configure-powershell-windows-vm#user-assigned-managed-identity) +- [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 PrincipalId value of the user-assigned managed identity in variable that you'll use in the upcoming steps: +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 "").PrincipalId +$MI_ID = (Get-AzUserAssignedIdentity -Name "" -ResourceGroupName "").ClientId ``` - \ is the name of the user-assigned managed identity. @@ -527,7 +566,7 @@ $MI_ID = (Get-AzUserAssignedIdentity -Name "" -ResourceGroupName For example: ```powershell -$MI_ID = (Get-AzUserAssignedIdentity -Name "ContosoMI1" -ResourceGroupName "ContosoRG2").PrincipalId +$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). @@ -547,10 +586,10 @@ The steps for user-assigned managed identity are the same as in [System-assigned 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 Azure AD roles to the managed identity +### 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-azure-ad-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 Azure AD role to (not the automation account itself). +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 6c0e8fc321..75be6dcc6a 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -1,8 +1,8 @@ --- 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 @@ -13,7 +13,7 @@ ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Learn how to use the Exchange Online PowerShell V2 module or V3 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 @@ -22,32 +22,23 @@ This article contains instructions for how to connect to Exchange Online PowerSh 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). -> [!NOTE] -> Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). - 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 connect to Exchange Online PowerShell from C#, see [Use C# to connect to Exchange Online PowerShell](connect-to-exo-powershell-c-sharp.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-deprecation-in-exchange-online-september/ba-p/3609437), see [Basic auth - Connect to Exchange Online PowerShell](basic-auth-connect-to-exo-powershell.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). This older version of the module will eventually be retired. - ## What do you need to know before you begin? - 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] - > If you're using the EXO V3 module (v3.0.0 or v2.0.6-PreviewX) and you don't use the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command, you'll have access to REST API cmdlets _only_. For more information, see [Updates for version 3.0.0 (the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-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). > - > Remote PowerShell support in Exchange Online PowerShell will be deprecated. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). + > 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. @@ -70,17 +61,13 @@ Import-Module ExchangeOnlineManagement The command that you need to run uses the following syntax: ```powershell -Connect-ExchangeOnline -UserPrincipalName [-UseRPSSession] [-ExchangeEnvironmentName ] [-ShowBanner:$false] [-DelegatedOrganization ] [-PSSessionOption $ProxyOptions] +Connect-ExchangeOnline -UserPrincipalName [-ExchangeEnvironmentName ] [-ShowBanner:$false] [-LoadCmdletHelp] [-DelegatedOrganization ] [-SkipLoadingFormatData] [-DisableWAM] ``` For detailed syntax and parameter information, see [Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline). -**Notes**: - - _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). -- With the EXO V3 module (v3.0.0 or v2.0.6-PreviewX), if you don't use the _UseRPSSession_ switch, you're using REST API cmdlets only. For more information, see [Updates for version 3.0.0 (the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module). - - 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: |Environment|Value| @@ -93,16 +80,20 @@ For detailed syntax and parameter information, see [Connect-ExchangeOnline](/pow \* 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. -- 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). +- 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. -- If you're behind a proxy server, you can use the _PSSessionOption_ parameter in the connection command, but only if you also use the _UseRPSSession_ switch. 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). +- 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). - 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. - 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. +- Use the _SkipLoadingFormatData_ switch to avoid errors when connecting to Exchange Online PowerShell from within a Windows service. + - Using the module in PowerShell 7 requires version 2.0.4 or later. +- 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. + The connection examples in the following sections use modern authentication, and are incapable of using Basic authentication. ### Connect to Exchange Online PowerShell with an interactive login prompt @@ -171,7 +162,7 @@ The connection examples in the following sections use modern authentication, and 2. On any other device with a web browser and internet access, open and enter the \ code value from the previous step. 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. @@ -180,17 +171,6 @@ The connection examples in the following sections use modern authentication, and For complete instructions, see [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md). -> [!IMPORTANT] -> The following example also connects without a login prompt, but the credentials are stored locally, so this method is not secure. Consider using this method only for brief testing purposes. - -```powershell -$secpasswd = ConvertTo-SecureString -String '' -AsPlainText -Force - -$o365cred = New-Object System.Management.Automation.PSCredential ("navin@contoso.onmicrosoft.com", $secpasswd) - -Connect-ExchangeOnline -Credential $o365cred -``` - ### Connect to Exchange Online PowerShell in customer organizations For more information about partners and customer organizations, see the following topics: @@ -210,7 +190,7 @@ This example connects to customer organizations in the following scenarios: ### Connect to Exchange Online PowerShell using managed identity -Managed identity is currently supported for Azure Virtual Machines, Virtual Machine Scale Sets, and Azure Functions. For more information about managed identity, see [What are managed identities for Azure resources?](/azure/active-directory/managed-identities-azure-resources/overview). +For more information, see [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). - System-assigned managed identity: @@ -226,7 +206,7 @@ Managed identity is currently supported for Azure Virtual Machines, Virtual Mach ## 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'll need to wait for the sessions to expire. To disconnect the session, run the following command. +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 @@ -249,14 +229,24 @@ 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. -- To help prevent denial-of-service (DoS) attacks, when you connect using the _UseRPSSession_ switch, you're limited to five open connections to Exchange Online PowerShell. - -- 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). +- 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). + +- 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. @@ -374,7 +364,7 @@ This section attempts to compare older connection methods that have been replace $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 + $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 ``` @@ -402,7 +392,7 @@ This section attempts to compare older connection methods that have been replace - **New-PSSession with OAuth token**: ```powershell - $oauthTokenAsPassword = ConvertTo-SecureString "' -AsPlainText -Force + $oauthTokenAsPassword = ConvertTo-SecureString '' -AsPlainText -Force $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $oauthTokenAsPassword) @@ -417,6 +407,9 @@ This section attempts to compare older connection methods that have been replace - **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" ``` 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 c23a17da63..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,8 +1,8 @@ --- 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 @@ -13,7 +13,7 @@ ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Learn how to use the Exchange Online PowerShell V2 module or V3 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 @@ -22,17 +22,17 @@ This article contains instructions for how to connect to Exchange Online Protect 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). -> [!NOTE] -> Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). +For more information about Exchange Online Protection PowerShell, see [Exchange Online Protection PowerShell](exchange-online-protection-powershell.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-deprecation-in-exchange-online-september/ba-p/3609437), see [Basic auth - Connect to Exchange Online Protection PowerShell](basic-auth-connect-to-eop-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). ## 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). - - 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. - - 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](/exchange/standalone-eop/manage-admin-role-group-permissions-in-eop). @@ -47,7 +47,7 @@ These connection instructions use modern authentication and work with or without ## Step 1: Load the Exchange Online PowerShell module > [!NOTE] -> If the module is already installed, you can typically skip this step and run **Connect-IPPSSession** without manually loading the module first. +> 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: @@ -57,29 +57,32 @@ Import-Module ExchangeOnlineManagement ## Step 2: Connect and authenticate +> [!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. + The command that you need to run uses the following syntax: ```powershell -Connect-IPPSSession -UserPrincipalName -ConnectionUri `https://ps.protection.outlook.com/powershell-liveid/ [-PSSessionOption $ProxyOptions] +Connect-ExchangeOnline -UserPrincipalName [-ShowBanner:$false] ``` For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). -- 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). +- 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). -### Connect to Security & Compliance PowerShell with an interactive login prompt +### Connect to Exchange Online Protection PowerShell with an interactive login prompt -This example connects to Exchange Online Protection PowerShell in a Microsoft 365 organization: +This example works in Windows PowerShell 5.1 and PowerShell 7 for accounts with or without MFA: ```powershell -Connect-IPPSSession -UserPrincipalName navin@contoso.onmicrosoft.com -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ +Connect-ExchangeOnline -UserPrincipalName navin@contoso.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'll need to wait for the sessions to expire. To disconnect the session, run the following command. +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 @@ -99,14 +102,8 @@ 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. -- 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 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 index bcbd97d267..f34a86b8d1 100644 --- a/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md +++ b/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md @@ -2,8 +2,8 @@ title: Use C# to connect to Exchange Online PowerShell ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 8/21/2023 ms.audience: Admin audience: Admin ms.topic: article @@ -19,10 +19,15 @@ description: "Learn about using the Exchange Online PowerShell V3 module and C# # 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#updates-for-version-300-the-exo-v3-module) module to connect to Exchange Online from C#. +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 diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md index 0e17177a14..b35779fdaf 100644 --- a/exchange/docs-conceptual/connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -1,8 +1,8 @@ --- 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 @@ -13,7 +13,7 @@ ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Learn how to use the Exchange Online PowerShell V2 module and V3 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 @@ -22,23 +22,18 @@ This article contains instructions for how to connect to Security & Compliance P 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). -> [!NOTE] -> Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). - To connect to Security & Compliance PowerShell for automation, see [App-only authentication for unattended scripts](app-only-auth-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-deprecation-in-exchange-online-september/ba-p/3609437), 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. - ## What do you need to know before you begin? - 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 Exchange Online PowerShell 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 3.0.0 (the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module). + > 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/mdo-portal-permissions) 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). ## Step 1: Load the Exchange Online PowerShell module @@ -66,18 +61,19 @@ For detailed syntax and parameter information, see [Connect-IPPSSession](/powers - _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). -- The required _ConnectionUri_ and _AzureADAuthorizationEndpointUri_ values depend on the nature of your Microsoft 365 organization. Common values are described in the following table: - - |Environment|_ConnectionUri_|_AzureADAuthorizationEndpointUri_| - |---|---|---| - |Microsoft 365 or Microsoft 365 GCC|n/a\*|n/a\*\*| - |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`| - |Office 365 operated by 21Vianet|`https://ps.compliance.protection.partner.outlook.cn/powershell-liveid`|`https://login.chinacloudapi.cn/common`| - - \* 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. - - \*\* 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. +- 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` - 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). @@ -110,7 +106,7 @@ For detailed syntax and parameter information, see [Connect-IPPSSession](/powers - **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 + 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**. @@ -130,17 +126,6 @@ For detailed syntax and parameter information, see [Connect-IPPSSession](/powers For complete instructions, see [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md). -> [!IMPORTANT] -> The following example also connects without a login prompt, but the credentials are stored locally, so this method is not secure. Consider using this method only for brief testing purposes. - -```powershell -$secpasswd = ConvertTo-SecureString -String '' -AsPlainText -Force - -$o365cred = New-Object System.Management.Automation.PSCredential ("navin@contoso.onmicrosoft.com", $secpasswd) - -Connect-IPPSSession -Credential $o365cred -``` - ### Connect to Security & Compliance PowerShell in customer organizations The procedures in this section require version 3.0.0 or later of the module. @@ -159,12 +144,12 @@ This example connects to customer organizations in the following scenarios: - Connect to a customer organization as a guest user. ```powershell - Connect-IPPSSession -UserPrincipalName navin@contoso.onmicrosoft.com -DelegatedOrganization adatum.onmicrosoft.com -AzureADAuthorizationEndpointUri https://ps.compliance.protection.outlook.com/powershell-liveid/ + 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'll need to wait for the sessions to expire. To disconnect the session, run the following command. +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 @@ -187,12 +172,16 @@ 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 80af8012db..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). @@ -30,17 +30,43 @@ For additional management tasks related to remote PowerShell, see [Connect to Ex > > 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 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). +- 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 will 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. +- 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. @@ -102,29 +128,3 @@ $NPS = Get-Content "C:\My Documents\NoPowerShell.txt" $NPS | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} ``` - -## 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' -``` 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 9a80233e4f..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,28 +11,33 @@ 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). -> [!NOTE] -> 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). +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 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. > [!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 admin accounts. 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.onmicrosoft.com' -and $_.UserPrincipalName -ne 'admin2@contoso.onmicrosoft.com'...} | Set-User -RemotePowerShellEnabled $false`. + > 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 remote PowerShell access, create a new admin account in the Microsoft 365 admin center, and then use that account to give yourself remote PowerShell access using the procedures in this article. - -- 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). + > 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. - For detailed information about OPATH filter syntax in Exchange Online, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). @@ -41,24 +46,23 @@ Exchange Online PowerShell enables you to manage your Exchange Online organizati ## Enable or disable access to Exchange Online PowerShell for a user -This example disables access to Exchange Online PowerShell for the user david@contoso.onmicrosoft.com. +This example disables access to Exchange Online PowerShell for the user `david@contoso.onmicrosoft.com`. ```powershell -Set-User -Identity david@contoso.onmicrosoft.com -RemotePowerShellEnabled $false +Set-User -Identity david@contoso.onmicrosoft.com -EXOModuleEnabled $false ``` -This example enables access to Exchange Online PowerShell for the user chris@contoso.onmicrosoft.com. +This example enables access to Exchange Online PowerShell for the user `chris@contoso.onmicrosoft.com`. ```powershell -Set-User -Identity chris@contoso.onmicrosoft.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 @@ -68,7 +72,7 @@ To disable access to Exchange Online PowerShell for any number of users based on ```powershell $ = -ResultSize unlimited -Filter -$ | 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". @@ -76,7 +80,7 @@ This example removes access to Exchange Online PowerShell for all users whose ** ```powershell $DSA = Get-User -ResultSize unlimited -Filter "(RecipientType -eq 'UserMailbox') -and (Title -like 'Sales Associate*')" -$DSA | foreach {Set-User -Identity $_.WindowsEmailAddress -RemotePowerShellEnabled $false} +$DSA | foreach {Set-User -Identity $_.WindowsEmailAddress -EXOModuleEnabled $false} ``` ### Use a list of specific users @@ -86,33 +90,36 @@ To disable access to Exchange Online PowerShell for a list of specific users, us ```powershell $ = Get-Content -$ | 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.onmicrosoft.com
tjohnston@contoso.onmicrosoft.com
kakers@contoso.onmicrosoft.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" -$NPS | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} +$NoPS | foreach {Set-User -Identity $_ -EXOModuleEnabled $false} ``` -## View the Exchange Online PowerShell access for users +## View the Exchange Online PowerShell access status for users + +> [!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. -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: +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 "" | 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 all users who don't have access to Exchange Online PowerShell, run the following command: 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 63eceacdc4..5849e19153 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -1,9 +1,9 @@ --- -title: About the Exchange Online PowerShell V2 module and V3 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 @@ -15,123 +15,136 @@ ms.custom: ms.assetid: search.appverid: MET150 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 V2 module and V3 module that they use to connect to all Exchange-related PowerShell environments in Microsoft 365." +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 module -The Exchange Online PowerShell 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. - -> [!NOTE] -> Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). +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 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. -## Updates for version 3.0.0 (the EXO V3 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). + +## REST API connections in the EXO V3 module -Versions 3.0.0 is the General Availability (GA) release of the 2.0.6-PreviewX versions of the module, and is now known as the EXO V3 module. This version improves upon the historical capabilities of the EXO V2 module (version 2.0.5 and earlier) with the following features: +Exchange Online PowerShell and Security & Compliance PowerShell now use REST API connections for all cmdlets: -- [Certificate based authentication](app-only-auth-powershell-v2.md) (also known as CBA or app-only authentication) is available for Security & Compliance PowerShell. +- **Exchange Online PowerShell**: EXO V3 module v3.0.0 or later. +- **Security & Compliance PowerShell**: EXO V3 module v3.2.0 or later. -- Cmdlets backed by the REST API are available in Exchange Online PowerShell. REST API cmdlets have the following advantages over their historical counterparts: +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). - - **More secure**: REST API cmdlets have built-in support for modern authentication and 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. - - **More reliable**: REST API cmdlets handle transient failures with 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**: The connection avoids setting up a PowerShell runspace in Exchange Online PowerShell. +Cmdlets in REST API connections have the following advantages over their historical counterparts: - The benefits of REST API cmdlets in Exchange Online PowerShell are described in the following table: +- **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. - | |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| +The benefits of cmdlets in REST API connections are described in the following table: - > [!NOTE] - > Currently, no cmdlets in Security & Compliance PowerShell cmdlets are backed by the REST API. **All** cmdlets in Security & Compliance PowerShell still 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. - - - REST API cmdlets in Exchange Online PowerShell have the same cmdlet names and 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. - -- The _UseRPSSession_ switch in **Connect-ExchangeOnline** grants access to all existing remote PowerShell cmdlets in Exchange Online PowerShell: - - 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 to Exchange Online PowerShell, you have access to the REST API cmdlets _only_. - - Remote PowerShell support in Exchange Online PowerShell will be deprecated. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). - -- 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-exchange-online-powershell-module) that you encounter. - -- Use the [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet to get information about REST-based connections to Exchange Online 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-based connections. +| |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 before a **Connect-ExchangeOnline** command.|Returns nothing.| - |Run after **Connect-ExchangeOnline** command that uses the _UseRPSSession_ switch.|Returns nothing (use [Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)).| - |Run after a REST-based **Connect-ExchangeOnline** command (no _UseRPSSession_ switch).|Returns one connection information object.| - |Run after multiple REST-based **Connect-ExchangeOnline** commands.|Returns a collection of connection information objects.| - |Run after multiple **Connect-ExchangeOnline** commands with and without the _UseRPSSession_ switch.|Returns one connection information object for each REST-based session.| + |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. -- Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet in REST-based connections (you didn't use the _UseRPSSession_ switch) 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: -For additional information, see the [Release notes](#release-notes) section later in this article. + ```powershell + $Members = @("member1","member2",...,"member10000") -For information about switching from the older Exchange Online Remote PowerShell Module (V1) to the current release, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/moving-from-the-exchange-powershell-v1-module-to-the-v2-preview/ba-p/3450679). + Update-DistributionGroupMember -Identity DG01 -Members $Members + ``` -## Report bugs and issues for the Exchange Online PowerShell module + Instead, use the **Update-DistributionGroupMember** command to update fewer members, and then add the remaining members individually using an **Add-DistributionGroupMember** command. For example: -> [!NOTE] -> For GA versions of the module, open a support ticket for any problems that you're having. For Preview versions of the module, use the email address as described in this section. You can also use the email address for feedback and suggestions for both GA and Preview versions of the module. + ```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. -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: +## 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: ```powershell -Connect-ExchangeOnline -EnableErrorReporting -LogDirectoryPath -LogLevel All +Connect-ExchangeOnline -EnableErrorReporting -LogDirectoryPath -LogLevel All ``` -> [!NOTE] -> 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. - ## Cmdlets in the Exchange Online PowerShell module -All versions of the module contain nine exclusive **Get-EXO\*** cmdlets for Exchange Online PowerShell that are optimized for speed in bulk data retrieval scenarios (thousands and thousands of objects). The older related remote PowerShell cmdlets are still available. - -The improved Exchange Online PowerShell cmdlets that are available only in the 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 module cmdlet|Older related cmdlet| |---|---| @@ -145,25 +158,44 @@ The improved Exchange Online PowerShell cmdlets that are available only in the m |[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)| +> [!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 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)|[Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)|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 module are listed in the following table: |Cmdlet|Comments| |---|---| +|[Get-DefaultTenantBriefingConfig](/powershell/module/exchange/get-defaulttenantbriefingconfig)|Available in v3.2.0 or later.| +|[Set-DefaultTenantBriefingConfig](/powershell/module/exchange/set-defaulttenantbriefingconfig)|Available in v3.2.0 or later.| +|[Get-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0 or later.| +|[Set-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0 or later.| |[Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| |[Set-MyAnalyticsFeatureConfig](/powershell/module/exchange/set-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| |[Get-UserBriefingConfig](/powershell/module/exchange/get-userbriefingconfig)|Replaced by [Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig).| |[Set-UserBriefingConfig](/powershell/module/exchange/set-userbriefingconfig)|Replaced by [Set-MyAnalyticsFeatureConfig](/powershell/module/exchange/set-myanalyticsfeatureconfig).| |[Get-VivaInsightsSettings](/powershell/module/exchange/get-vivainsightssettings)|Available in v2.0.5 or later.| |[Set-VivaInsightsSettings](/powershell/module/exchange/set-vivainsightssettings)|Available in v2.0.5 or later.| +|[Get-VivaModuleFeature](/powershell/module/exchange/get-vivamodulefeature)|Available in v3.2.0 or later.| +|[Get-VivaModuleFeatureEnablement](/powershell/module/exchange/get-vivamodulefeatureenablement)|Available in v3.2.0 or later.| +|[Add-VivaModuleFeaturePolicy](/powershell/module/exchange/add-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Get-VivaModuleFeaturePolicy](/powershell/module/exchange/get-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Remove-VivaModuleFeaturePolicy](/powershell/module/exchange/remove-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Update-VivaModuleFeaturePolicy](/powershell/module/exchange/update-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Add-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/add-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| +|[Get-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/get-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| +|[Remove-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/remove-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| ## Install and maintain the Exchange Online PowerShell module @@ -187,10 +219,9 @@ The module is supported in the following versions of macOS: - 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: @@ -211,10 +242,9 @@ Now you can do the [regular PowerShell prerequisites](#prerequisites-for-the-exc 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 module in other distributions of Linux, [report any issues](#report-bugs-and-issues-for-the-exchange-online-powershell-module). +- 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). @@ -234,7 +264,7 @@ After you install PowerShell 7, do the following steps: Now you can do the [regular PowerShell prerequisites](#prerequisites-for-the-exchange-online-powershell-module) and [install the Exchange Online PowerShell module](#install-the-exchange-online-powershell-module). > [!NOTE] -> If you connect to Exchange Online PowerShell from a network that's behind a proxy server, the EXO V2 module (version v2.0.5 or earlier) doesn't work in Linux. You need to use the EXO V3 module (v3.0.0 or v2.0.6-PreviewX) 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 @@ -242,28 +272,28 @@ All versions of the module are supported in Windows PowerShell 5.1. PowerShell 7 on Windows requires version 2.0.4 or later. -Version 2.0.5 or later of the 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). +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 PowerShell requirements and module support **in older versions of Windows** are described in the following list: -- Windows 8.11 -- Windows Server 2012 or Windows Server 2012 R21 -- Windows 7 Service Pack 1 (SP1)2,3,4 -- Windows Server 2008 R2 SP12,3,4 +- Windows 8.1¹ +- Windows Server 2012 or Windows Server 2012 R2¹ +- Windows 7 Service Pack 1 (SP1)² ³ ⁴ +- Windows Server 2008 R2 SP1² ³ ⁴ -- 1 PowerShell 7 on this version of Windows requires the [Windows 10 Universal C Runtime (CRT)](https://www.microsoft.com/download/details.aspx?id=50410). -- 2 This version of Windows has reached its end of support, and is now supported only in Azure virtual machines. -- 3 This version of Windows supports only v2.0.3 or earlier versions of the module. -- 4 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). +- ¹ 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). ### Prerequisites for the Exchange Online PowerShell module -> [!NOTE] -> The settings described in this section are required in all versions of PowerShell on all operating systems. - #### 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. @@ -277,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-300-the-exo-v3-module), the EXO V3 module does not require Basic authentication in WinRM for REST-based connections to Exchange Online PowerShell. +> [!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. -For remote PowerShell connections, WinRM needs to allow Basic authentication. **We do not 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 does not support 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**: @@ -306,20 +336,28 @@ 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). - +> 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`. + +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: @@ -328,9 +366,9 @@ To install the module for the first time, complete the following steps: 2. Close and re-open the Windows PowerShell window. -3. Now you can use the **Install-Module** cmdlet to install the 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 any are 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): @@ -394,7 +432,7 @@ If the module is already installed on your computer, you can use the procedures 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'll want the latest public version of the module, but you can also upgrade to a Preview version if any are available. +2. You can use the **Update-Module** cmdlet to update the module from the PowerShell Gallery. Typically, you want the latest public version of the module, but you can also upgrade to a Preview version if any are available. - To upgrade to **the latest public version** of the module, run **one** of the following commands based on how you originally installed the module (all users vs. only for the current user account): @@ -460,14 +498,24 @@ For detailed syntax and parameter information, see [Update-Module](/powershell/m - 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: @@ -479,7 +527,7 @@ For detailed syntax and parameter information, see [Update-Module](/powershell/m 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: @@ -490,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' @@ -498,16 +546,6 @@ 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 To see the version of the module that's currently installed and where it's installed, run the following command: @@ -518,15 +556,10 @@ To see the version of the module that's currently installed and where it's insta 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. -To uninstall 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): +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): - ```powershell - Uninstall-Module -Name ExchangeOnlineManagement - ``` - -- 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 @@ -536,9 +569,9 @@ For detailed syntax and parameter information, see [Uninstall-Module](/powershel ## 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: @@ -554,20 +587,20 @@ In those cmdlets, property sets are controlled by the following parameters: 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 module 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. @@ -578,21 +611,90 @@ For more information about filtering in the module, see [Filters in the Exchange Unless otherwise noted, the current release of the Exchange Online PowerShell module contains all features of previous releases. -### Current release: Version 3.0.0 (Preview versions known as v2.0.6-PreviewX) +### 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. -- Features already described in the [Updates for version 3.0.0 (the EXO V3 module)](#updates-for-version-300-the-exo-v3-module) section: +### 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. + +#### Version 3.5.1 + +- Bug fixes in **Get-EXOMailboxPermission** and **Get-EXOMailbox**. +- The module has been upgraded to run on .NET 8, replacing the previous version based on .NET 6. +- Enhancements in **Add-VivaModuleFeaturePolicy**. + +#### Version 3.5.0 + +- New **Get-VivaFeatureCategory** cmdlet. +- Added support for policy operations at the category level in Viva Feature Access Management (VFAM). +- New IsFeatureEnabledByDefault property in the output of **Get-VivaModuleFeaturePolicy**. The value of this property shows the default enablement state for users in the tenant when no tenant or user/group policies were created. + +#### Version 3.4.0 + +- Bug fixes in **Connect-ExchangeOnline**, **Get-EXORecipientPermission**, and **Get-EXOMailboxFolderPermission**. +- The _SigningCertificate_ parameter in **Connect-ExchangeOnline** now supports [Constrained Language Mode (CLM)](/powershell/module/microsoft.powershell.core/about/about_language_modes#constrainedlanguage-mode). + +#### Version 3.3.0 + +- _SkipLoadingCmdletHelp_ parameter on **Connect-ExchangeOnline** to support skip loading cmdlet help files. +- Global variable `EXO_LastExecutionStatus` is available to check the status of the last cmdlet that was run. +- Bug fixes in **Connect-ExchangeOnline** and **Connect-IPPSSession**. +- _IsUserControlEnabled_ parameter on **Add-VivaModuleFeaturePolicy** and **Update-VivaModuleFeaturePolicy** to support the enablement of user controls by policy for features that are onboarded to Viva feature access management. + +#### Version 3.2.0 + +- New cmdlets: + - **Get-DefaultTenantBriefingConfig** and **Set-DefaultTenantBriefingConfig**. + - **Get-DefaultTenantMyAnalyticsFeatureConfig** and **Set-DefaultTenantMyAnalyticsFeatureConfig**. + - **Get-VivaModuleFeature**, **Get-VivaModuleFeatureEnablement**, **Add-VivaModuleFeaturePolicy**, **Get-VivaModuleFeaturePolicy**, **Remove-VivaModuleFeaturePolicy**, and **Update-VivaModuleFeaturePolicy**. +- REST API connection support for Security & Compliance PowerShell. +- _ConnectionId_ parameter on **Get-ConnectionInformation** and **Disconnect-ExchangeOnline**: + - Get connection information for specific REST API connections. + - Selective disconnect for REST API connections. +- _SigningCertificate_ parameter on **Connect-ExchangeOnline** allows you to sign the format files (\*.Format.ps1xml) or script module files (.psm1) in the temporary module that **Connect-ExchangeOnline** creates with a client certificate to use in all PowerShell execution policies. +- Bug fixes in **Connect-ExchangeOnline**. + +#### Version 3.1.0 + +- _AccessToken_ parameter available in **Connect-ExchangeOnline**. +- Bug fixes in **Connect-ExchangeOnline** and **Get-ConnectionInformation**. +- Bug fix in **Connect-IPPSSession** for connecting to Security & Compliance PowerShell using _CertificateThumbprint_. + +#### Version 3.0.0 (Preview versions known as v2.0.6-PreviewX) + +- Features already described in the [REST API connections in the EXO V3 module](#rest-api-connections-in-the-exo-v3-module) section: - [Certificate based authentication](app-only-auth-powershell-v2.md) for Security & Compliance PowerShell (version 2.0.6-Preview5 or later). - The [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet for REST-based connections (version 2.0.6-Preview7 or later). - The _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet for REST-based connections (version 2.0.6-Preview8 or later). - The _DelegatedOrganization_ parameter works in the **Connect-IPPSSession** cmdlet as long as you also use the _AzureADAuthorizationEndpointUri_ parameter in the command. -- Certain cmdlets that used to prompt for confirmation in specific scenarios no longer do so. By default, the cmdlet will run to completion. -- The format of the error returned from failed cmdlet execution has been slightly modified. The exception now contains additional data (for example, the exception type), and the `FullyQualifiedErrorId` does not contain the `FailureCategory`. The format of the error is subject to further modification. - -### Previous releases +- 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** cmdlet to manage ownerless Microsoft 365 groups. +- 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. @@ -605,9 +707,9 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo - 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 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). +- 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. @@ -623,11 +725,11 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo - 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. @@ -640,45 +742,45 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo - 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 11d62f1fc5..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,23 +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 learn about the Exchange Online PowerShell module that's required to connect to Exchange Online PowerShell, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.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). - > [!NOTE] - > Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 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). -- To create a 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 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 learn about app-only authentication (also known as certificate based authentication or CBA) in Exchange Online PowerShell for unattended scripts using AzureAD applications and self-signed certificates, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](app-only-auth-powershell-v2.md). +- To connect to Exchange Online PowerShell, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.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). + 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). diff --git a/exchange/docs-conceptual/exchange-online-protection-powershell.md b/exchange/docs-conceptual/exchange-online-protection-powershell.md index 1e39b38aea..93e9dd4bf7 100644 --- a/exchange/docs-conceptual/exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/exchange-online-protection-powershell.md @@ -2,33 +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 EOP to protect your on-premises email environment. If you have a Microsoft 365 subscription that includes Exchange Online mailboxes (A3/E3/G3, A5/E5/G5, Microsoft 365 Business Premium, 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 learn about the Exchange Online PowerShell 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 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). - > [!NOTE] - > Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 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). -- 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 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 learn about the structure and layout of the cmdlet reference articles in Exchange Online Protection PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). +- To connect to Exchange Online Protection PowerShell, see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). -- 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 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 4754c12c2a..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,24 +34,22 @@ 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*'"`). @@ -59,79 +57,100 @@ The properties that have been _confirmed_ to work with the _Filter_ parameter in - 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 +## 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`| +|_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'"`. -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. +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`. -### AcceptMessagesOnlyFromDLMembers +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`| +|_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'"`. -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. +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`. -### ActiveSyncAllowedDeviceIDs +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'"`. +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 +## 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'"`. +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`. -### ActiveSyncEnabled +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| |---|---|---| -|_|**Get-CASMailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| For example, `Get-CasMailbox -Filter 'ActiveSyncEnable -eq $false'`. -### ActiveSyncMailboxPolicy +## ActiveSyncMailboxPolicy |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchMobileMailboxPolicyLink_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`| +|_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'"`. -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`). +You can find the distinguished names of ActiveSync mailbox policies by running this command: `Get-MobileDeviceMailboxPolicy | Format-List Name,DistinguishedName`. -### ActiveSyncSuppressReadReceipt +> [!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| |---|---|---| -|_|**Get-CASMailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| For example, `Get-CasMailbox -Filter 'ActiveSyncSuppressReadReceipt -eq $true'`. -### AddressBookPolicy +## AddressBookPolicy |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchAddressBookPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`| +|_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`. +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'"`. -### AddressListMembership +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`| +|_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'"`. -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`. +You can find the distinguished names of address lists by running this command: `Get-AddressList | Format-List Name,DistinguishedName`. -### AdminDisplayName +## AdminDisplayName |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -139,55 +158,59 @@ This filter requires the distinguished name of the address list. For example, `G For example, `Get-SecurityPrincipal -Filter 'AdminDisplayName -ne $null' | Format-Table -Auto Name,AdminDisplayName`. -### AdministrativeUnits +## 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**|String or `$null`| +|_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 +## AggregatedMailboxGuids |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchAlternateMailboxes_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| +|_msExchAlternateMailboxes_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| For example, `Get-Mailbox -Filter 'AggregatedMailboxGuids -ne $null'`. -### Alias +## 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)| +|_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 +## AllowUMCallsFromNonUsers |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchUMListInDirectorySearch_|**Get-Contact**
**Get-LinkedUser**
**Get-UMMailbox**
**Get-User**|`None` (0) or `SearchEnabled` (1)| +|_msExchUMListInDirectorySearch_|**Get-Contact**
**Get-LinkedUser**
**Get-UMMailbox**
**Get-User**|`None` (0) or `SearchEnabled` (1)| For example, `Get-User -Filter "AllowUMCallsFromNonUsers -ne 'SearchEnabled'"`. -### ArbitrationMailbox +## 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`| +|_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`. +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'"`. -### ArchiveDatabase +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`| +|_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'"`. -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`. +You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`. -### ArchiveDomain +## ArchiveDomain |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -195,71 +218,79 @@ This filter requires the distinguished name of the archive mailbox database. For 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 +## ArchiveGuid |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchArchiveGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| +|_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`. +This filter requires the GUID of the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveMailbox -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"`. -### ArchiveName +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`| +|_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*'"`. -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`. +You can find the names of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveName`. -### ArchiveQuota +## 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.| +|_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'"`. +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'"`. -### ArchiveRelease +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`.| +|_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 +## ArchiveState |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0), `Local` (1), `HostedProvisioned` (2), `HostedPending` (3), or `OnPremise` (4).| +|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 +## ArchiveStatus |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchArchiveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0) or `Active` (1).| +|_msExchArchiveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0) or `Active` (1).| For example, `Get-Recipient -Filter "ArchiveStatus -eq 'Active'"`. -### ArchiveWarningQuota +## 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.| +|_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 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'"`. +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 +## AssistantName |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchAssistantName_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| +|_msExchAssistantName_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "AssistantName -like 'Julia*'"`. -### AuditEnabled +## AuditEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -267,15 +298,15 @@ For example, `Get-User -Filter "AssistantName -like 'Julia*'"`. For example, `Get-Mailbox -Filter 'AuditEnabled -eq $true'`. -### AuditLogAgeLimit +## 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.| +|_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 +## AuthenticationPolicy |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -283,7 +314,7 @@ You can't use the _Filter_ parameter to look for time span values for this prope 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 +## BlockedSendersHash |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -291,23 +322,27 @@ For example, `Get-User -Filter "AuthenticationPolicy -eq 'CN=Block Basic Auth,CN 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 |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_c_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String (wildcards accepted) or `$null`| +|_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'"`. +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. -### CalendarLoggingQuota +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'"`. +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 +## CalendarRepairDisabled |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -315,183 +350,211 @@ You can only use the _Filter_ parameter to look for the value `Unlimited` for th For example, `Get-Mailbox -Filter 'CalendarRepairDisabled -eq $true'`. -### CertificateSubject +## CertificateSubject |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-LinkedUser**
**Get-User**|String or `$null`| +|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`') +The X509 certificate that's published for the user account (visible on the **Published Certificates** tab in Active Directory Users and Computers). -### City +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`| +|_l_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "City -eq 'Redmond'"`. -### Company +## Company |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_company_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| +|_company_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "Company -like 'Contoso*'"`. -### ComplianceTagHoldApplied +## ComplianceTagHoldApplied |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**
**Get-MailUser**|Boolean (`$true` or `$false`)| +|n/a|**Get-Mailbox**
**Get-MailUser**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'ComplianceTagHoldApplied -eq $true'`. -### ConsumerNetID +## ConsumerNetID |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-LinkedUser**
**Get-User**|String or `$null`| +|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`| For example, `Get-User -Filter 'ConsumerNetID -ne $null'`. -### CountryCode +## CountryCode |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_countryCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|Integer| +|_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. -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"`. +For example, `Get-User -Filter "countryCode -eq 796"`. -### CountryOrRegion +## CountryOrRegion |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_co_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String| +|_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. -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*'"`. +For example, `Get-User -Filter "CountryOrRegion -like 'United*'"`. -### CustomAttribute1 to CustomAttribute15 +## 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`| +|_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 +## Database |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_homeMDB_|**Get-Mailbox**
**Get-Recipient**|String| +|_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`. +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'"`. -### DefaultPublicFolderMailbox +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`. +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 |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_deletedItemFlags_|**Get-Mailbox**
**Get-SecurityPrincipal**|`DatabaseDefault` (0), `RetainUntilBackupOrCustomPeriod` (3), or `RetainForCustomPeriod` (5).| +|_deletedItemFlags_|**Get-Mailbox**
**Get-SecurityPrincipal**|`DatabaseDefault` (0), `RetainUntilBackupOrCustomPeriod` (3), or `RetainForCustomPeriod` (5).| For example, `Get-Mailbox -Filter "DeletedItemFlags -ne 'DatabaseDefault'"`. -### DeliverToMailboxAndForward +## DeliverToMailboxAndForward |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_deliverAndRedirect_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-MailPublicFolder**|Boolean (`$true` or `$false`)| +|_deliverAndRedirect_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-MailPublicFolder**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'DeliverToMailboxAndForward -eq $true'`. -### Department +## Department |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_department_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| +|_department_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-Recipient -Filter "Department -like 'Engineering*'"`. -### DirectReports +## DirectReports |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_directReports_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`| +|_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`. -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. +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. -### DisabledArchiveDatabase +## DisabledArchiveDatabase |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchDisabledArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| +|_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`. +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'"`. -### DisabledArchiveGuid +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`| +|_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'"`. -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`. +You can find the GUID of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID`. -### DisplayName +## 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)| +|_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 |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| +|_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'"`. -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`. +You can find the distinguished names of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,DistinguishedName`. -### EcpEnabled +## EcpEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-CASMailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| For example, `Get-CASMailbox -Filter 'EcpEnabled -eq $false'`. -### EmailAddresses +## 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)| +|_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. +For example, `Get-Recipient -Filter "EmailAddresses -like 'marketing*'"`. -### EmailAddressPolicyEnabled +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| |---|---|---| -|_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| +|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 +## 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`. +For example, `Get-MailPublicFolder -Filter "EntryId -like '60000*'"`. -### EwsApplicationAccessPolicy +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| |---|---|---| @@ -499,7 +562,7 @@ For example, `Get-MailPublicFolder -Filter "EntryId -like '60000*'"`.
You c For example, `Get-CASMailbox -Filter 'EwsApplicationAccessPolicy -ne $null'`. -### EwsEnabled +## EwsEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -507,63 +570,79 @@ For example, `Get-CASMailbox -Filter 'EwsApplicationAccessPolicy -ne $null'`. For example, `Get-CASMailbox -Filter "EwsEnabled -eq 1"`. -### ExchangeGuid +## ExchangeGuid |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchMailboxGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String| +|_msExchMailboxGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String| + +For example, `Get-Mailbox -Filter "ExchangeGuid -eq 'c80a753d-bd4a-4e19-804a-6344d833ecd8'"`. -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`. +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`. -### ExchangeUserAccountControl +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)| +|_msExchUserAccountControl_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|`None` (0) or `AccountDisabled` (2)| For example, `Get-Mailbox -Filter "ExchangeUserAccountControl -eq 'AccountDisabled'"`. -### ExchangeVersion +## 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| +|_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. -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"`. +For example, `Get-Recipient -Filter "ExchangeVersion -lt 88218628259840"`. -### ExpansionServer +## ExpansionServer |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchExpansionServerName_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Recipient**|String (wildcards accepted) or `$null`| +|_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`. +For example, `Get-Recipient -Filter "ExpansionServer -like 'Mailbox01*'"`. -### ExtensionCustomAttribute1 to ExtensionCustomAttribute5 +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`| +|_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 +## 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`| +|_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 +## ExternalEmailAddress |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_targetAddress_|**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**|String (wildcards accepted) or `$null`| +|_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. +For example, `Get-Recipient -Filter "ExternalEmailAddress -like '@fabrikam.com*'"`. -### ExternalOofOptions +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| |---|---|---| @@ -571,103 +650,121 @@ For example, `Get-Recipient -Filter "ExternalEmailAddress -like '@fabrikam.com*' For example, `Get-Mailbox -Filter "ExternalOofOptions -eq 'External'"`. -### Fax +## Fax |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_facsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| +|_facsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "Fax -like '206*'"`. -### FirstName +## FirstName |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_givenName_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| +|_givenName_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "FirstName -like 'Chris*'"`. -### ForwardingAddress +## ForwardingAddress |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_altRecipient_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| +|_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'"`. -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`. +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 +## 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. +For example, `Get-Mailbox -Filter "ForwardingSmtpAddress -like '@fabrikam.com*'"`. -### GeneratedOfflineAddressBooks +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 is a multivalued property, the filter will return a match if the property _contains_ the specified value. +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 +## 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`| +|_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. +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'"`. -### GroupMemberCount +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| +|n/a|**Get-UnifiedGroup**|Integer| For example, `Get-UnifiedGroup -Filter "GroupMemberCount -gt 100"`. -### GroupExternalMemberCount +## GroupExternalMemberCount |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_n/a_|**Get-UnifiedGroup**|Integer| +|n/a|**Get-UnifiedGroup**|Integer| For example, `Get-UnifiedGroup -Filter "GroupExternalMemberCount -gt 0"`. -### GroupType +## 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).| +|_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. +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'"`. -### Guid +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| +|_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'"`. -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. +You can find the GUIDs of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,Guid`. -### HasActiveSyncDevicePartnership +Note that an object's GUID value is different than its Exchange GUID value. + +## HasActiveSyncDevicePartnership |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-CASMailbox**
**Get-Recipient**|Boolean (`$true` or `$false`)| +|n/a|**Get-CASMailbox**
**Get-Recipient**|Boolean (`$true` or `$false`)| For example, `Get-Recipient -Filter 'HasActiveSyncDevicePartnership -eq $true'`. -### HiddenFromAddressListsEnabled +## 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`)| +|_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 +## HiddenGroupMembershipEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -675,367 +772,411 @@ For example, `Get-Recipient -Filter 'HiddenFromAddressListsEnabled -eq $true'`. For example, `Get-UnifiedGroup -Filter 'HiddenGroupMembershipEnabled -eq $true'`. -### HomePhone +## HomePhone |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_homePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| +|_homePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "HomePhone -like '206*'"`. -### Id +## 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| +|_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'"`. -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`. +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 +## IgnoreMissingFolderLink |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-MailPublicFolder**|Boolean (`$true` or `$false`)| +|n/a|**Get-MailPublicFolder**|Boolean (`$true` or `$false`)| For example, `Get-MailPublicFolder -Filter 'IgnoreMissingFolderLink -eq $true'`. -### ImapEnabled +## ImapEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-CASMailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| For example, `Get-CASMailbox -Filter 'ImapEnabled -eq $false'`. -### ImmutableId +## ImmutableId |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchGenericImmutableId_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| +|_msExchGenericImmutableId_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| For example, `Get-Mailbox -Filter 'ImmutableId -ne $null'`. -### IncludeInGarbageCollection +## IncludeInGarbageCollection |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'IncludeInGarbageCollection -eq $true'`. -### Initials +## Initials |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_initials_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| +|_initials_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "Initials -like 'B.'"`. -### InPlaceHolds +## InPlaceHolds |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchUserHoldPolicies_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String| +|_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`. -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. +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. -### InPlaceHoldsRaw +## InPlaceHoldsRaw |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-LinkedUser**
**Get-User**|String| +|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. +This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter "InPlaceHoldsRaw -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"`. -### IsDirSynced +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`)| +|_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 +## IsExcludedFromServingHierarchy |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'IsExcludedFromServingHierarchy -eq $true'`. -### IsHierarchyReady +## IsHierarchyReady |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'IsHierarchyReady -eq $false'`. -### IsHierarchySyncEnabled +## IsHierarchySyncEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'IsHierarchySyncEnabled -eq $false'`. -### IsInactiveMailbox +## IsInactiveMailbox |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'IsInactiveMailbox -eq $false'`. -### IsLinked +## IsLinked |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|Boolean (`$true` or `$false`)| +|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'IsLinked -eq $true'`. -### IsMailboxEnabled +## IsMailboxEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'IsMailboxEnabled -eq $false'`. -### IsResource +## IsResource |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'IsResource -eq $true'`. -### IsSecurityPrincipal +## IsSecurityPrincipal |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-LinkedUser**
**Get-User**|Boolean (`$true` or `$false`)| +|n/a|**Get-LinkedUser**
**Get-User**|Boolean (`$true` or `$false`)| For example, `Get-User -Filter 'IsSecurityPrincipal -eq $false'`. -### IsShared +## IsShared |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'IsShared -eq $true'`. -### IsSoftDeletedByDisable +## IsSoftDeletedByDisable |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)| +|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 +## IsSoftDeletedByRemove |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)| +|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 +## 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.| +|_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'"`. +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'"`. -### JournalArchiveAddress +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| |---|---|---| -|_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String| +|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 +## 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. +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'"`. -### LastExchangeChangedTime +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)| +|_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 |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)| +|_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*'"`. -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` +You can find LegacyExchangeDN values for users by running this command: `Get-User | Format-List Name,LegacyExchangeDN` -### LitigationHoldDate +## 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)| +|_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 +## LitigationHoldEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'LitigationHoldEnabled -eq $true'`. -### LitigationHoldOwner +## LitigationHoldOwner |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchLitigationHoldOwner_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| +|_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 +## LastName |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_sn_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| +|_sn_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "LastName -like 'Martin*'"`. -### MailboxContainerGUID +## MailboxContainerGUID |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchMailboxContainerGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| +|_msExchMailboxContainerGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| For example, `Get-Mailbox -Filter 'MailboxContainerGUID -ne $null'`. -### MailboxMoveBatchName +## MailboxMoveBatchName |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchMailboxMoveBatchName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| +|_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*'"`. -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:`. +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 +## 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).| +|_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. +For example, `Get-Mailbox -Filter "MailboxMoveFlags -ne 'None'"`. -### MailboxMoveRemoteHostName +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`| +|_msExchMailboxMoveRemoteHostName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| For example, `Get-Mailbox -Filter 'MailboxMoveRemoteHostName -ne $null'`. -### MailboxMoveSourceMDB +## MailboxMoveSourceMDB |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchMailboxMoveSourceMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| +|_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`. +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'"`. -### MailboxMoveStatus +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).| +|_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 +## MailboxMoveTargetMDB |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchMailboxMoveTargetMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| +|_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'"`. -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`. +You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`. -### MailboxPlan +## 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'`. +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. -### MailboxRelease +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`.| +|_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 +## 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`| +|_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 |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_managedBy_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-UnifiedGroup**|String or `$null`| +|_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'"`. -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. +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`. -### ManagedFolderMailboxPolicy +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`| +|_msExchMailboxTemplateLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`| + +Managed folder mailbox policies aren't available in Exchange 2013 or later. -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`. +For example, `Get-Mailbox -Filter 'ManagedFolderMailboxPolicy -eq $null'`. -### Manager +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`| +|_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.` +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'"`. -### MAPIEnabled +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| |---|---|---| -|_|**Get-CASMailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| For example, `Get-CASMailbox -Filter 'MAPIEnabled -eq $false'`. -### MasterAccountSid +## MasterAccountSid |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchMasterAccountSid_|**Get-Mailbox**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String or `$null`| +|_msExchMasterAccountSid_|**Get-Mailbox**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String or `$null`| + +For example, `Get-Mailbox -Filter 'MasterAccountSid -ne $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). +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 +## MaxBlockedSenders |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1043,15 +1184,17 @@ For example, `Get-Mailbox -Filter 'MasterAccountSid -ne $null'`.
This value For example, `Get-Mailbox -Filter "MaxBlockedSenders -gt 0"`. -### MaxReceiveSize +## 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.| +|_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'"`. +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'"`. -### MaxSafeSenders +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| |---|---|---| @@ -1059,15 +1202,17 @@ You can only use the _Filter_ parameter to look for the value `Unlimited` for th For example, `Get-Mailbox -Filter "MaxSafeSenders -gt 0"`. -### MaxSendSize +## 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.| +|_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 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'"`. +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 +## MemberDepartRestriction |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1075,7 +1220,7 @@ You can only use the _Filter_ parameter to look for the value `Unlimited` for th For example, `Get-DistributionGroup -Filter "MemberDepartRestriction -eq 'ApprovalRequired'"`. -### MemberJoinRestriction +## MemberJoinRestriction |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1083,111 +1228,135 @@ For example, `Get-DistributionGroup -Filter "MemberDepartRestriction -eq 'Approv For example, `Get-DistributionGroup -Filter "MemberJoinRestriction -eq 'ApprovalRequired'"`. -### MemberOfGroup +## 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`| +|_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`. -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. +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. -### Members +## Members |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_member_|**Get-DistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-SecurityPrincipal**|String or `$null`| +|_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. +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'"`. -### MobilePhone +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`| +|_mobile_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "MobilePhone -like '555*'"`. -### ModeratedBy +## 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| +|_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`. -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. +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. -### ModerationEnabled +## 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`)| +|_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 |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)| +|_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 +## NetID |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|String or `$null`| +|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'`. +This property is populated for Exchange Online mailboxes in hybrid environments. A sample value is `1003BFFD9A0CFA03`. -### Notes +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`| +|_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 |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| +|_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/`. -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'"`. +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. -### ObjectClass +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| +|_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 -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. +For example, `Get-Recipient -Filter "ObjectClass -eq 'Contact'"`. -### Office +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`| +|_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 +## 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`. +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 +## OnPremisesObjectId |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-MailPublicFolder**|String or `$null`| +|n/a|**Get-MailPublicFolder**|String or `$null`| For example, `Get-MailPublicFolder -Filter 'OnPremisesObjectId -ne $null'`. -### OperatorNumber +## OperatorNumber |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1195,39 +1364,39 @@ For example, `Get-MailPublicFolder -Filter 'OnPremisesObjectId -ne $null'`. For example, `Get-UMMailbox -Filter "OperatorNumber -eq 5"`. -### OtherFax +## OtherFax |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_otherFacsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| +|_otherFacsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "OtherFax -like '206*'"`. -### OtherHomePhone +## OtherHomePhone |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_otherHomePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| +|_otherHomePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "OtherHomePhone -like '206*'"`. -### OtherTelephone +## OtherTelephone |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_otherTelephone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| +|_otherTelephone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "OtherTelephone -like '206*'"`. -### OWAEnabled +## OWAEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-CASMailbox**|Boolean (`$true` or `$false`)| +|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 +## OWAforDevicesEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1235,39 +1404,45 @@ The filter operates backwards. For example, `Get-CASMailbox -Filter 'OWAEnabled For example, `Get-CASMailbox -Filter 'OWAForDevicesEnabled -eq $true'`. -### OWAMailboxPolicy +## OWAMailboxPolicy |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchOWAPolicy_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`| +|_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`. +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`'". -### Pager +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`| +|_pager_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "Pager -like '206*'"`. -### PersistedCapabilities +## PersistedCapabilities |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| +|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)). -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. +For example, `Get-Mailbox -Filter 'PersistedCapabilities -ne $null'`. -### Phone +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`| +|_telephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "Phone -like '206*'"`. -### PhoneProviderId +## PhoneProviderId |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1275,175 +1450,207 @@ For example, `Get-User -Filter "Phone -like '206*'"`. For example, `Get-UMMailbox -Filter "PhoneProviderId -like '206*'"`. -### PhoneticDisplayName +## 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`| +|_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 +## 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`| +|_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 +## 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`| +|_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 +## PopEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-CASMailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| For example, `Get-CASMailbox -Filter 'POPEnabled -eq $false'`. -### PostalCode +## PostalCode |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_postalCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| +|_postalCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-Recipient -Filter "PostalCode -eq 90210"`. -### PostOfficeBox +## PostOfficeBox |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_postOfficeBox_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| +|_postOfficeBox_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "PostOfficeBox -like '555*'"`. -### PreviousRecipientTypeDetails +## PreviousRecipientTypeDetails |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchPreviousRecipientTypeDetails_|**Get-LinkedUser**
**Get-User**|String or `$null`| +|_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 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'`. +For example, `Get-User -Filter 'PreviousRecipientTypeDetails -ne $null'`. -### PrimarySmtpAddress +## PrimarySmtpAddress |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**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)| +|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 +## 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.| +|_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 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'"`. +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 +## 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.| +|_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'"`. +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'"`. -### ProtocolSettings +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`| +|_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). -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*'"`. +For example, `Get-Mailbox -Filter "ProtocolSettings -like 'POP3*'"`. -### PublicFolderContacts +## 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 is a multivalued property, the filter will return a match if the property _contains_ the specified value. +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`. -### QueryBaseDN +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'`. +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 +## 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`. +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'"` -### RecipientLimits +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`| +|_msExchRecipLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Integer or `Unlimited`| For example, `Get-Mailbox -Filter "RecipientLimits -ne 'Unlimited'"`. -### RecipientType +## RecipientType |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**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`| +|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 +## RecipientTypeDetails |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**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| +|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 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'"`. +For example, `Get-Recipient -Filter "RecipientTypeDetails -eq 'SharedMailbox'"`. -### RecoverableItemsQuota +## 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.| +|_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'"`. +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'"`. -### RecoverableItemsWarningQuota +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.| +|_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 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'"`. +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 +## 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`| +|_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`. -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. +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. -### RejectMessagesFromDLMembers +## 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`| +|_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. +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'"`. -### RemoteAccountPolicy +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| |---|---|---| @@ -1451,55 +1658,55 @@ This filter requires the distinguished name or canonical distinguished name of t 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 +## RemotePowerShellEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-User**|Boolean (`$true` or `$false`)| +|n/a|**Get-User**|Boolean (`$true` or `$false`)| For example, `Get-User -Filter 'RemotePowerShellEnabled -eq $false'`. -### RemoteRecipientType +## 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`.| +|_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 +## ReportToManagerEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_reportToOwner_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| +|_reportToOwner_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| For example, `Get-DistributionGroup -Filter 'ReportToManagerEnabled -eq $true'`. -### ReportToOriginatorEnabled +## ReportToOriginatorEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_reportToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| +|_reportToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| For example, `Get-DistributionGroup -Filter 'ReportToOriginatorEnabled -eq $false'`. -### RequireAllSendersAreAuthenticated +## 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`)| +|_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 +## ResourceBehaviorOptions |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-UnifiedGroup**|`AllowOnlyMembersToPost`, `CalendarMemberReadOnly`, `ConnectorsEnabled`, `HideGroupInOutlook`, `NotebookForLearningCommunitiesEnabled`, `ReportToOriginator`, `SharePointReadonlyForMembers`, `SubscriptionEnabled`, `SubscribeMembersToCalendarEvents`, `SubscribeMembersToCalendarEventsDisabled`, `SubscribeNewGroupMembers`, `WelcomeEmailDisabled`, `WelcomeEmailEnabled`, or `$null`| +|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 +## ResourceCapacity |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1507,71 +1714,77 @@ For example, `Get-UnifiedGroup -Filter "ResourceBehaviorOptions -eq 'CalendarMem For example, `Get-Mailbox -Filter "ResourceCapacity -gt 15"` -### ResourceCustom +## ResourceCustom |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**|String or `$null`| +|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`. -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'"`. +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 +## ResourceProvisioningOptions |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-UnifiedGroup**|`Team` or `$null`| +|n/a|**Get-UnifiedGroup**|`Team` or `$null`| For example, `Get-UnifiedGroup -Filter "ResourceProvisioningOptions -eq 'Team'"` -### ResourceType +## ResourceType |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**
**Get-Recipient**|`Room` (0), `Equipment` (1), or `$null`| +|n/a|**Get-Mailbox**
**Get-Recipient**|`Room` (0), `Equipment` (1), or `$null`| For example, `Get-Mailbox -Filter "ResourceType -eq 'Equipment'"` -### RetainDeletedItemsFor +## 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.| +|_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 +## RetentionComment |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchRetentionComment_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| +|_msExchRetentionComment_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| For example, `Get-Mailbox -Filter "RetentionComment -like '7 years*'"` -### RetentionPolicy +## RetentionPolicy |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**
**Get-Recipient**|String or `$null`| +|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`. +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'"`. -### RetentionUrl +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`| +|_msExchRetentionURL_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| For example, `Get-Mailbox -Filter "RetentionUrl -like 'https://intranet.contoso.com/*'"` -### RoleAssignmentPolicy +## 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`. +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 +## RulesQuota |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1579,7 +1792,7 @@ This filter requires the distinguished name of the role assignment policy in Exc 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 +## SafeRecipientsHash |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1587,7 +1800,7 @@ You can't use the _Filter_ parameter to look for size values of this property. I Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'SafeRecipientsHash -ne $null'.` -### SafeSendersHash +## SafeSendersHash |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1595,15 +1808,15 @@ Realistically, you can only use this value to filter on blank or non-blank 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 |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`| +|_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 +## SCLDeleteThresholdInt |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1611,7 +1824,7 @@ For example, `Get-Recipient -Filter "SamAccountName -like 'laura*'"` 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 +## SCLJunkThresholdInt |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1619,7 +1832,7 @@ This property is displayed as **SCLDeleteThreshold** in the results of the comma 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 +## SCLQuarantineThresholdInt |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1627,7 +1840,7 @@ This property is displayed as **SCLJunkThreshold** in the results of the command 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 +## SCLRejectThresholdInt |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1635,135 +1848,144 @@ This property is displayed as **SCLQuarantineThreshold** in the results of the c 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 +## SendOofMessageToOriginatorEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_oOFReplyToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| +|_oOFReplyToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| For example, `Get-DistributionGroup -Filter 'SendOofMessageToOriginatorEnabled -eq $true'`. -### ServerLegacyDN +## ServerLegacyDN |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchHomeServerName_|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String (wildcards accepted) or `$null`| +|_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`. +For example, `Get-Mailbox -Filter "ServerLegacyDN -like 'Mailbox01'"`. -### ServerName +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| |---|---|---| -|_|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String or `$null`| +|n/a|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String or `$null`| For example, `Get-Recipient -Filter "ServerName -eq 'Mailbox01'"`. -### SharingPolicy +## SharingPolicy |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchSharingPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`| +|_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'"`. -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`). +To find the distinguished names of sharing policies, run this command: `Get-SharingPolicy | Format-List Name,DistinguishedName`. -### Sid +> [!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| +|_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 |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_SIDHistory_|**Get-Group**
**Get-LinkedUser**
**Get-User**|String or `$null`| +|_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 +## 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`| +|_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 +## SingleItemrecoveryEnabled |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'SingleItemRecoveryEnabled -eq $true'`. -### SKUAssigned +## SKUAssigned |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|Boolean (`$true` or `$false`) or `$null`.| +|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 +## SourceAnchor |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-Mailbox**|String (wildcards accepted) or `$null`| +|n/a|**Get-Mailbox**|String (wildcards accepted) or `$null`| For example, `Get-Mailbox -Filter 'SourceAnchor -ne $null'`. -### StateOrProvince +## StateOrProvince |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_st_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| +|_st_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "StateOrProvince -like 'Carolina*'"`. -### StreetAddress +## StreetAddress |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_streetAddress_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| +|_streetAddress_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "StreetAddress -like '36th Ave NE*'"`. -### StsRefreshTokensValidFrom +## 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)| +|_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 |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_telephoneAssistant_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| +|_telephoneAssistant_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "TelephoneAssistant -like '206*'"`. -### ThrottlingPolicy +## 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`. +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'"`. -### Title +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`| +|_title_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| For example, `Get-User -Filter "Title -eq 'Dr.'"`. -### UMAddresses +## UMAddresses |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1771,71 +1993,81 @@ For example, `Get-User -Filter "Title -eq 'Dr.'"`. For example, `Get-UMMailbox -Filter 'UMAddresses -ne $null'`. -### UMCallingLineIds +## UMCallingLineIds |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchUMCallingLineIds_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| +|_msExchUMCallingLineIds_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "UMCallingLineIds -like '123*'"`. -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. +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. -### UMDtmfMap +## 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`| +|_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. +For example, `Get-Mailbox -Filter "UMDtmfMap -like '26297*'"`. -### UMEnabled +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| |---|---|---| -|_|**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|Boolean (`$true` or `$false`)| +|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|Boolean (`$true` or `$false`)| For example, `Get-Mailbox -Filter 'UMEnabled -eq $true'`. -### UMMailboxPolicy +## UMMailboxPolicy |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchUMTemplateLink_|**Get-Recipient**
**Get-UMMailbox**|String or `$null`| +|_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'"`. -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`. +To find the distinguished names of UM mailbox policies, run this command: `Get-UMMailboxPolicy | Format-List Name,DistinguishedName`. -### UMRecipientDialPlanId +## 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`. +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'"`. -### UpgradeRequest +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| |---|---|---| -|_|**Get-User**|`None` (0), `TenantUpgrade` (1), `PrestageUpgrade` (2), `CancelPrestageUpgrade` (3), `PilotUpgrade` (4), or `TenantUpgradeDryRun` (5),| +|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 +## UpgradeStatus |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**Get-User**|`None` (0), `NotStarted` (1), `InProgress` (2), `Warning` (3), `Error` (4), `Cancelled` (5), `Complete` (6), or `ForceComplete` (7).| +|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 +## UsageLocation |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchUsageLocation_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**|String or `$null`| +|_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). -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'`. +For example, `Get-Recipient -Filter 'UsageLocation -eq "US"'`. -### UseDatabaseQuotaDefaults +## UseDatabaseQuotaDefaults |LDAP display name|Available on cmdlets|Value| |---|---|---| @@ -1843,102 +2075,108 @@ This filter requires the ISO 3166-1 country name (for example, `United States`), For example, `Get-Mailbox -Filter 'UseDatabaseQuotaDefaults -eq $false'`. -### UserAccountControl +## UserAccountControl |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_userAccountControl_|**Get-LinkedUser**
**Get-User**|`AccountDisabled`, `DoNotExpirePassword`, or `NormalAccount`| +|_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. +For example, `Get-User -Filter "UserAccountControl -eq 'NormalAccount'"`. -### UserPrincipalName +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)| +|_userPrincipalName_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted)| For example, `Get-User -Filter "UserPrincipalName -like 'julia@*'"`. -### VoiceMailSettings +## VoiceMailSettings |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchUCVoiceMailSettings_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`| +|_msExchUCVoiceMailSettings_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`| For example, `Get-User -Filter 'VoiceMailSettings -ne $null'`. -### WebPage +## WebPage |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_wWWHomePage_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| +|_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 |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)| +|_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 +## WhenChangedUTC |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**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)| +|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 |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)| +|_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 +## WhenCreatedUTC |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_|**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)| +|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 +## 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)| +|_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 +## 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)| +|_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. -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'"`. +For example, `Get-Mailbox -SoftDeletedMailbox -Filter "WhenSoftDeleted -gt '8/1/2017 2:00:00 PM'"`. -### WindowsEmailAddress +## 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`| +|_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 +## WindowsLiveID |LDAP display name|Available on cmdlets|Value| |---|---|---| -|_msExchWindowsLiveID_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| +|_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 4190869598..aae21efdc2 100644 --- a/exchange/docs-conceptual/filters-v2.md +++ b/exchange/docs-conceptual/filters-v2.md @@ -2,8 +2,8 @@ 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 @@ -21,11 +21,11 @@ description: "Learn about how to use filtering for cmdlets in the Exchange Onlin 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). -> [!NOTE] -> Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). - 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 Server-side filtering uses the available _Filter_ or _RecipientFilter_ parameters on a cmdlet. diff --git a/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md index 04836ef8fe..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/mdo-portal-permissions) - - [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/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-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-automation-account-id.png b/exchange/docs-conceptual/media/mi-automation-account-id.png deleted file mode 100644 index 2636c08b2c..0000000000 Binary files a/exchange/docs-conceptual/media/mi-automation-account-id.png and /dev/null 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 168a148790..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*'" @@ -177,18 +187,15 @@ When creating your own custom OPATH filters, consider the following items: - **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. - **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 not enclosed**: Enclose the whole OPATH filter in double quotation marks, single quotation marks, or braces (for example `"CountryCode -eq 840"`). + - **Integer values**: To ensure they work in all cases, enclose them in one of the following ways: - **Integer enclosed in single quotation marks**: Enclose the whole OPATH filter in double quotation marks or braces `"CountryCode -eq '840'"`. - **Integer enclosed in double quotation marks**: Enclose the whole OPATH filter in braces (for example `{CountryCode -eq "840"}`). @@ -196,21 +203,16 @@ When creating your own custom OPATH filters, consider the following items: 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,16 +228,19 @@ 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| |---|---| diff --git a/exchange/docs-conceptual/recipientfilter-properties.md b/exchange/docs-conceptual/recipientfilter-properties.md index e1abb8051e..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 @@ -40,7 +40,10 @@ The recipient properties that have been *confirmed* to work with the _RecipientF - 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). + + > [!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). @@ -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 45893f016e..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,24 +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 learn about the Exchange Online PowerShell module that's required to connect to Security & Compliance PowerShell, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). +- To learn about the ExchangeOnlineManagement module that's required to connect to Security & Compliance PowerShell, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). - > [!NOTE] - > Version 2.0.5 and earlier is known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). Version 3.0.0 and later is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 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). -- To create a 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 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 learn about app-only authentication (also known as certificate based authentication or CBA) in Security & Compliance PowerShell for unattended scripts using AzureAD applications and self-signed certificates, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](app-only-auth-powershell-v2.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](/microsoft-365/security/office-365-security/anti-spam-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 5bb4a9ce83..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: @@ -38,6 +36,8 @@ 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 @@ -57,10 +57,6 @@ href: filters-v2.md - 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: @@ -72,12 +68,10 @@ href: app-only-auth-powershell-v2.md - name: Exchange cmdlet syntax href: exchange-cmdlet-syntax.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: 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: Exchange Online Protection PowerShell href: exchange-online-protection-powershell.md items: @@ -89,5 +83,3 @@ href: exchange-cmdlet-syntax.md - name: What's new in the Exchange Online PowerShell module href: whats-new-in-the-exo-module.md - - name: Basic auth - Connect to Exchange Online Protection PowerShell - href: basic-auth-connect-to-eop-powershell.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 030575a0e6..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 module, which only uses modern authentication, and supports accounts with or without MFA. For installation and connection instructions, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module) and [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). For details on moving from this older version of the module to the current version, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/moving-from-the-exchange-powershell-v1-module-to-the-v2-preview/ba-p/3450679). - -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 17dcfcedfa..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 module, which only uses modern authentication, and supports accounts with or without MFA. For installation and connection instructions, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module) and [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). For details on moving from this older version of the module to the current version, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/moving-from-the-exchange-powershell-v1-module-to-the-v2-preview/ba-p/3450679). - -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/mdo-portal-permissions) 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 index f1ba6d0a0b..64e027b733 100644 --- a/exchange/docs-conceptual/whats-new-in-the-exo-module.md +++ b/exchange/docs-conceptual/whats-new-in-the-exo-module.md @@ -2,14 +2,14 @@ title: What's new in the Exchange Online PowerShell module ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 03/26/2025 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-online ms.reviewer: -ms.localizationpriority: normal +ms.localizationpriority: medium ms.collection: Strat_EX_Admin ms.custom: ms.assetid: @@ -22,6 +22,92 @@ description: "Learn about the new features and functionality available in the la 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). @@ -31,6 +117,10 @@ This article lists new features in the Exchange Online PowerShell module that's - 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 [Updates for version 3.0.0 (the EXO V3 module)](exchange-online-powershell-v2.md#updates-for-version-300-the-exo-v3-module). + 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 2131c3c9cf..c1daf4b98b 100644 --- a/exchange/exchange-ps/exchange/Add-ADPermission.md +++ b/exchange/exchange-ps/exchange/Add-ADPermission.md @@ -63,7 +63,7 @@ Add-ADPermission [[-Identity] ] -Instance -ForestNam [-DomainController ] [-ProxyUrl ] [-TargetAutodiscoverEpr ] + [-TargetServiceEpr ] + [-TargetTenantId ] [-UseServiceAccount ] [-WhatIf] [] @@ -43,24 +45,31 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 @@ -160,7 +169,7 @@ 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://learn.microsoft.com/powershell/module/exchange/new-federationtrust). @@ -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 f51a813847..ddec608aad 100644 --- a/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 34184b4150..72bcef12ec 100644 --- a/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md +++ b/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md b/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md index ea2174b9b3..d987ed4c56 100644 --- a/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md +++ b/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md @@ -57,10 +57,10 @@ This example adds the IP address 192.168.0.100 to the list of allowed IP address ### Example 2 ```powershell -Add-IPAllowListEntry -IPRange 192.168.0.1/24 -ExpirationTime "1/3/2013 23:59" +Add-IPAllowListEntry -IPRange 192.168.0.1/24 -ExpirationTime "1/3/2014 23:59" ``` -This example adds the IP address range 192.168.0.1/24 to the list of allowed IP addresses and configures the IP Allow list entry to expire at 23:59 on January 3, 2013. +This example adds the IP address range 192.168.0.1/24 to the list of allowed IP addresses and configures the IP Allow list entry to expire at 23:59 on January 3, 2014. ## PARAMETERS @@ -137,7 +137,7 @@ Accept wildcard characters: False ### -ExpirationTime The ExpirationTime parameter specifies a day and time when the IP Allow list entry that you're creating will expire. If you specify a time only and you don't specify a date, the current day is assumed. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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/Add-IPBlockListEntry.md b/exchange/exchange-ps/exchange/Add-IPBlockListEntry.md index 372d0fd6a5..35072b31fd 100644 --- a/exchange/exchange-ps/exchange/Add-IPBlockListEntry.md +++ b/exchange/exchange-ps/exchange/Add-IPBlockListEntry.md @@ -56,10 +56,10 @@ This example adds the IP address 192.168.0.100 to the list of blocked IP address ### Example 2 ```powershell -Add-IPBlockListEntry -IPRange 192.168.0.1/24 -ExpirationTime "1/3/2013 23:59" +Add-IPBlockListEntry -IPRange 192.168.0.1/24 -ExpirationTime "1/3/2014 23:59" ``` -This example adds the IP address range 192.168.0.1/24 to the list of blocked IP addresses and configures the IP Block list entry to expire at 23:59 on January 3, 2013. +This example adds the IP address range 192.168.0.1/24 to the list of blocked IP addresses and configures the IP Block list entry to expire at 23:59 on January 3, 2014. ## PARAMETERS @@ -136,7 +136,7 @@ Accept wildcard characters: False ### -ExpirationTime The ExpirationTime parameter specifies a day and time when the IP Block list entry that you're creating will expire. If you specify a time only and you don't specify a date, the current day is assumed. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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/Add-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md index fcc11c1a09..bda1bfce49 100644 --- a/exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md @@ -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 diff --git a/exchange/exchange-ps/exchange/Add-MailboxPermission.md b/exchange/exchange-ps/exchange/Add-MailboxPermission.md index 0522eee754..07ab0e946e 100644 --- a/exchange/exchange-ps/exchange/Add-MailboxPermission.md +++ b/exchange/exchange-ps/exchange/Add-MailboxPermission.md @@ -242,9 +242,14 @@ The User parameter specifies who gets the permissions on the mailbox. You can sp - Mail users - Mail-enabled security groups (non-mail-enabled security groups are selectable, but they don't work) -**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. See the [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) 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 3d303cab9d..6b98323cb7 100644 --- a/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md +++ b/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md @@ -263,9 +263,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://learn.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. diff --git a/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md index 4c4fc6401b..059bc10445 100644 --- a/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md +++ b/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md @@ -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 2cdc810122..06dfc9280a 100644 --- a/exchange/exchange-ps/exchange/Add-RecipientPermission.md +++ b/exchange/exchange-ps/exchange/Add-RecipientPermission.md @@ -131,6 +131,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/Add-ResubmitRequest.md b/exchange/exchange-ps/exchange/Add-ResubmitRequest.md index 58bce184f8..d1801a114d 100644 --- a/exchange/exchange-ps/exchange/Add-ResubmitRequest.md +++ b/exchange/exchange-ps/exchange/Add-ResubmitRequest.md @@ -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 de1559cf8c..5f64ff5636 100644 --- a/exchange/exchange-ps/exchange/Add-RoleGroupMember.md +++ b/exchange/exchange-ps/exchange/Add-RoleGroupMember.md @@ -61,7 +61,7 @@ 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://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) -- WhatIf, Confirm and ValidateOnly switches +- [WhatIf, Confirm and ValidateOnly switches](https://learn.microsoft.com/exchange/whatif-confirm-and-validateonly-switches-exchange-2013-help) ### Example 3 ```powershell @@ -93,11 +93,9 @@ 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't add security groups or mail-enabled security groups as members of the role group in the Microsoft Purview portal. You should add them via PowerShell with this parameter. - You can use any value that uniquely identifies the user or group. For example: - Name diff --git a/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md index 2012741570..e58e810aba 100644 --- a/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md @@ -16,7 +16,10 @@ This cmdlet is available only in the cloud-based service. Use the Add-UnifiedGroupLinks cmdlet to add members, owners and subscribers to Microsoft 365 Groups in your cloud-based organization. To remove members, owners, and subscribers, use the Remove-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) 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). +> [!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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -43,11 +46,12 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Add-UnifiedGroupLinks -Identity "Legal Department" -LinkType Members -Links chris@contoso.com,michelle@contoso.com ``` -This example adds members chris@contoso.com and michelle@contoso.com to the Microsoft 365 Group named Legal Department. +This example adds members `chris@contoso.com` and `michelle@contoso.com` to the Microsoft 365 Group named Legal Department. ### Example 2 ```powershell $users= Get-User -ResultSize unlimited | where {$_.Department -eq "Marketing" -AND $_.RecipientType -eq "UserMailbox"} + Add-UnifiedGroupLinks -Identity Marketing -LinkType members -Links ($users.UserPrincipalName) ``` @@ -79,7 +83,7 @@ Accept wildcard characters: False ``` ### -Links -The Links parameter specifies the recipients to add to the Microsoft 365 Group. You specify whether these recipients are members, owners or subscribers by using the LinkType parameter. +The Links parameter specifies the recipients to add to the Microsoft 365 Group. You specify whether these recipients are members, owners, or subscribers by using the LinkType parameter. You can use any value that uniquely identifies the recipient. For example: @@ -92,7 +96,9 @@ You can use any value that uniquely identifies the recipient. For example: 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 must use this parameter with the LinkType parameter, which means the specified recipients will all receive the same role in the Microsoft 365 Group (you can't add recipients with different roles in the same command). +You must use this parameter with the LinkType parameter, which means the specified recipients receive the same role in the Microsoft 365 Group (you can't add recipients with different roles in the same command). + +**Note**: 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. ```yaml Type: RecipientIdParameter[] @@ -112,11 +118,11 @@ The LinkType parameter specifies the recipient's role in the Microsoft 365 Group - 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). +- Subscribers: Existing group 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). -In PowerShell, any owner or subscriber that you want to add to the group must also be a member. +You must use this parameter with the Links parameter. -You must use this parameter with the LinkType parameter. +**Note**: 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. ```yaml Type: LinkType diff --git a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md new file mode 100644 index 0000000000..340921a576 --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -0,0 +1,344 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/add-vivamodulefeaturepolicy +applicable: Exchange Online +title: Add-VivaModuleFeaturePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Add-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 Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva. The attributes of the policy are defined using the cmdlet parameters. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. + +- You can assign up to 10 policies per feature. An additional one policy per feature can be assigned to the entire tenant. +- Policies assigned to a specific user or group take priority over the policy assigned to the entire tenant when determining whether a feature is enabled. If a user has multiple policies assigned for a feature (directly as a user or member of a group), the most restrictive policy applies. +- Some features only support policies that apply to the entire tenant, not specific users or groups. You can refer to supported policy scopes for a feature using the [Get-VivaModuleFeature](https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature) cmdlet. + +Some features include the option for user controls (user opt out). Refer to the feature documentation to see if user controls are available for the feature that you intend to set a policy for. + +For 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-VivaModuleFeaturePolicy -FeatureId -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 6e4db4a2d5..ddb6eb30ff 100644 --- a/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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/Clear-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md index 730dcf37d9..f729195ad5 100644 --- a/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md +++ b/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md @@ -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 68309558ab..9a5eda7425 100644 --- a/exchange/exchange-ps/exchange/Clear-MobileDevice.md +++ b/exchange/exchange-ps/exchange/Clear-MobileDevice.md @@ -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/Complete-MigrationBatch.md b/exchange/exchange-ps/exchange/Complete-MigrationBatch.md index f2318ee0c0..922eeca5b8 100644 --- a/exchange/exchange-ps/exchange/Complete-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Complete-MigrationBatch.md @@ -39,7 +39,7 @@ 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. @@ -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 ef0d9feb83..96f0891ba3 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -15,9 +15,9 @@ ms.reviewer: ## SYNOPSIS 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 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://learn.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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -42,8 +42,10 @@ Connect-ExchangeOnline [-CertificateThumbprint ] [-Credential ] [-Device] + [-DisableWAM] [-EnableErrorReporting] [-InlineCredential] + [-LoadCmdletHelp] [-LogDirectoryPath ] [-LogLevel ] [-ManagedIdentity] @@ -52,6 +54,8 @@ Connect-ExchangeOnline [-PageSize ] [-ShowBanner] [-ShowProgress ] + [-SigningCertificate ] + [-SkipLoadingCmdletHelp] [-SkipLoadingFormatData] [-TrackPerformance ] [-UseMultithreading ] @@ -61,7 +65,7 @@ Connect-ExchangeOnline ``` ## DESCRIPTION -This cmdlet creates a PowerShell connection to your Exchange Online organization. You can use this cmdlet to authenticate for REST API-backed cmdlets in the Exchange Online PowerShell V3 module and also for all existing Exchange Online PowerShell cmdlets (remote PowerShell cmdlets). +This cmdlet creates a PowerShell connection to your Exchange Online organization. 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. @@ -72,46 +76,32 @@ Connect commands will likely fail if the profile path of the account that you us 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 WinRM on the local computer. +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. - -### 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 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 ``` @@ -123,7 +113,7 @@ In PowerShell 7.0.3 or later using version 2.0.4 or later of the module, this ex ### -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` @@ -131,8 +121,6 @@ The ConnectionUri parameter specifies the connection endpoint for the remote Exc - 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 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). - ```yaml Type: String Parameter Sets: (All) @@ -149,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` @@ -195,6 +183,8 @@ Accept wildcard characters: False ``` ### -PSSessionOption +**Note**: This parameter doesn't work in REST API connections. + 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. 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`). @@ -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 works only 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 the primary .onmicrosoft.com domain of the delegated organization for the value of this parameter. +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,10 +223,11 @@ Accept wildcard characters: False ``` ### -Prefix -The Prefix parameter specifies a text value to add to the beginning of remote PowerShell cmdlet names when you connect. +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. -- You can't use spaces or special characters like underscores or asterisks. -- You can't use the value EXO. This value is reserved for the nine exclusive **Get-EXO\*** cmdlets in the module. +- The Prefix value can't contain spaces or special characters like underscores or asterisks. +- You can't use the Prefix value EXO. That value is reserved for the nine exclusive **Get-EXO\*** cmdlets that are built into the module. +- The Prefix parameter affects only imported Exchange Online cmdlet names. It doesn't affect the names of cmdlets that are built into the module (for example, Disconnect-ExchangeOnline). ```yaml Type: String @@ -284,11 +275,11 @@ Accept wildcard characters: False ``` ### -AccessToken -**Note**: This parameter is available in version 3.1.0-Preview1 or later of the module. +**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 ExchangeOnline. +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 parameter. +Depending on the type of access token, you need to use this parameter with the Organization, DelegatedOrganization, or UserPrincipalName parameters. ```yaml Type: String @@ -358,7 +349,7 @@ 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. @@ -388,6 +379,8 @@ You can use the following methods as a value for this parameter: For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). +**Note**: Using a **ConvertTo-SecureString** command to store the password of the certificate locally defeats the purpose of a secure connection method for automation scenarios. Using a **Get-Credential** command to prompt you for the password of the certificate securely isn't ideal for automation scenarios. In other words, there's really no automated _and_ secure way to connect using a local certificate. + ```yaml Type: SecureString Parameter Sets: (All) @@ -467,6 +460,26 @@ 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 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EnableErrorReporting The EnableErrorReporting switch specifies whether to enable error reporting. You don't need to specify a value with this switch. @@ -505,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`. @@ -540,8 +575,6 @@ Accept wildcard characters: False ``` ### -ManagedIdentity -**Note**: This parameter is available in version 2.0.6-Preview7 or later of the module. - The ManagedIdentity switch specifies that you're using managed identity to connect. You don't need to specify a value with this switch. Managed identity connections are currently supported for the following types of Azure resources: @@ -571,8 +604,6 @@ Accept wildcard characters: False ``` ### -ManagedIdentityAccountId -**Note**: This parameter is available in version 2.0.6-Preview7 or later of the module. - The ManagedIdentityAccountId parameter specifies the user-assigned managed identity that you're using to connect. A valid value for this parameter is the application ID (GUID) of the service principal that corresponds to the user-assigned managed identity in Azure. You must use this parameter with the Organization parameter and the ManagedIdentity switch. @@ -593,7 +624,7 @@ Accept wildcard characters: False ``` ### -Organization -The Organization parameter specifies the organization when you connect using CBA or managed identity. You must use the primary .onmicrosoft.com domain of the organization for the value of this parameter. +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). @@ -666,14 +697,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipLoadingFormatData -**Note**: This parameter is available in version 2.0.6-Preview8 or later of the module. +### -SigningCertificate +**Note**: This parameter is available in version 3.2.0 or later of the module. -The SkipLoadingFormatData switch avoids downloading the format data for REST API connections. You don't need to specify a value with this switch. +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. -This switch does not work with the UseRPSSession switch. +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 @@ -694,7 +771,7 @@ The TrackPerformance parameter measures additional events (for example, CPU load - $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 @@ -729,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 entering a username in the modern authentication credentials prompt (you're prompted to enter a 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). @@ -747,13 +824,13 @@ Accept wildcard characters: False ``` ### -UseRPSSession -This parameter is available in version 2.0.6-Preview3 or later of the 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 Exchange Online PowerShell module](https://aka.ms/exov3-module#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. +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 5bec864274..a260cad194 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -15,9 +15,9 @@ ms.reviewer: ## SYNOPSIS 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 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**: Currently, this cmdlet still requires Basic authentication to be enabled in WinRM on the local computer. 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). +**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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -32,6 +32,7 @@ Connect-IPPSSession [[-Prefix] ] [[-CommandName] ] [[-FormatTypeName] ] + [-AccessToken ] [-AppId ] [-BypassMailboxAnchoring] [-Certificate ] @@ -41,70 +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). - -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://learn.microsoft.com/powershell/module/exchange/connect-exchangeonline) cmdlet in the [Exchange Online PowerShell connection instructions](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) to connect to your EOP PowerShell environment. - 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 Exchange Online PowerShell 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 Exchange Online PowerShell 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 Exchange Online PowerShell 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 @@ -120,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` @@ -165,7 +148,9 @@ Accept wildcard characters: False ``` ### -PSSessionOption -The PSSessionOption parameter specifies the PowerShell session options to use in your connection to Exchange Online. +**Note**: This parameter doesn't work in REST API connections. + +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. 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`). @@ -183,10 +168,11 @@ Accept wildcard characters: False ``` ### -Prefix -The Prefix parameter specifies a text value to add to the beginning of remote PowerShell cmdlet names when you connect. +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. -- You can't use spaces or special characters like underscores or asterisks. -- You can't use the value EXO. This value is reserved for the nine exclusive **Get-EXO\*** cmdlets in the module. +- 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 @@ -233,6 +219,26 @@ 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`. @@ -288,7 +294,7 @@ 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. @@ -318,6 +324,8 @@ You can use the following methods as a value for this parameter: For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). +**Note**: Using a **ConvertTo-SecureString** command to store the password of the certificate locally defeats the purpose of a secure connection method for automation scenarios. Using a **Get-Credential** command to prompt you for the password of the certificate securely isn't ideal for automation scenarios. In other words, there's really no automated _and_ secure way to connect using a local certificate. + ```yaml Type: SecureString Parameter Sets: (All) @@ -409,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 9fd6bd2f02..87bea6279a 100644 --- a/exchange/exchange-ps/exchange/Connect-Mailbox.md +++ b/exchange/exchange-ps/exchange/Connect-Mailbox.md @@ -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) @@ -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. @@ -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 0cc2e9df2f..3dc21e421f 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -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,6 +36,8 @@ Delete-QuarantineMessage -Identities ``` Delete-QuarantineMessage -Identity [-Confirm] + [-EntityType ] + [-HardDelete] [-RecipientAddress ] [-WhatIf] [] @@ -54,6 +58,7 @@ 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] ``` @@ -62,6 +67,7 @@ This example deletes the 5th quarantined message in the list of results from Get ### Example 3 ```powershell $ids = Get-QuarantineMessage | select -ExpandProperty Identity + Delete-QuarantineMessage -Identities $ids -Identity 000 ``` @@ -139,6 +145,45 @@ 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 The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. @@ -146,7 +191,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 @@ -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 7b24a5e4b7..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://learn.microsoft.com/powershell/module/exchange/disable-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Disable-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -30,7 +30,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 9de3fdcaac..45471267d2 100644 --- a/exchange/exchange-ps/exchange/Disable-AddressListPaging.md +++ b/exchange/exchange-ps/exchange/Disable-AddressListPaging.md @@ -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 f992c8e5f0..df08fecd4f 100644 --- a/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md +++ b/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md @@ -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 307f7e2fec..881f7f9195 100644 --- a/exchange/exchange-ps/exchange/Disable-App.md +++ b/exchange/exchange-ps/exchange/Disable-App.md @@ -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 a9b01c5e0f..071e1f83ec 100644 --- a/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md @@ -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 f317c252a0..e773646d76 100644 --- a/exchange/exchange-ps/exchange/Disable-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Disable-DistributionGroup.md @@ -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 ccf9572759..b611fc63b1 100644 --- a/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md @@ -30,7 +30,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 b700c49ae1..7adfa0cbae 100644 --- a/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md +++ b/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md @@ -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 840d087fed..442273d3c0 100644 --- a/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md @@ -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 118435c9b4..7bc6e6bce3 100644 --- a/exchange/exchange-ps/exchange/Disable-InboxRule.md +++ b/exchange/exchange-ps/exchange/Disable-InboxRule.md @@ -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-JournalRule.md b/exchange/exchange-ps/exchange/Disable-JournalRule.md index 7b0ea4e3b7..f36f1eaaaa 100644 --- a/exchange/exchange-ps/exchange/Disable-JournalRule.md +++ b/exchange/exchange-ps/exchange/Disable-JournalRule.md @@ -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 7dc2e160a2..97902c5fd6 100644 --- a/exchange/exchange-ps/exchange/Disable-MailContact.md +++ b/exchange/exchange-ps/exchange/Disable-MailContact.md @@ -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 c5de0b1f57..a4aadbbe70 100644 --- a/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md +++ b/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md @@ -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 9f9879a37d..c0728ff91a 100644 --- a/exchange/exchange-ps/exchange/Disable-MailUser.md +++ b/exchange/exchange-ps/exchange/Disable-MailUser.md @@ -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 eeed6f6f54..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://learn.microsoft.com/powershell/module/exchange/disable-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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 dde427413a..98aaf73776 100644 --- a/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md +++ b/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md @@ -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 774dd17e06..127a8f0542 100644 --- a/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md @@ -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-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md index d81f0164c6..6032b60587 100644 --- a/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md +++ b/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md @@ -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 fde18c993c..ade8f3935d 100644 --- a/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md +++ b/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md @@ -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 d8e88399be..8039e5d1fd 100644 --- a/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md @@ -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/Disable-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md index c50a2330c3..8e8073a184 100644 --- a/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md +++ b/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md @@ -63,6 +63,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-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md index 299ec309dc..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://learn.microsoft.com/powershell/module/exchange/disable-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Disable-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -28,7 +28,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-attachments-about). +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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 abb3a14788..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://learn.microsoft.com/powershell/module/exchange/disable-safelinksrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Disable-SafeLinksRule schema: 2.0.0 author: chrisda @@ -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 35a346184f..13a29e56ed 100644 --- a/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md +++ b/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md @@ -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-TransportAgent.md b/exchange/exchange-ps/exchange/Disable-TransportAgent.md index 7bae966b27..5ccd3fab73 100644 --- a/exchange/exchange-ps/exchange/Disable-TransportAgent.md +++ b/exchange/exchange-ps/exchange/Disable-TransportAgent.md @@ -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 4c1bdff21d..03d4189525 100644 --- a/exchange/exchange-ps/exchange/Disable-TransportRule.md +++ b/exchange/exchange-ps/exchange/Disable-TransportRule.md @@ -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-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md index 2467bcb058..d9f8154eaf 100644 --- a/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md @@ -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 f20225aab3..f0738b7185 100644 --- a/exchange/exchange-ps/exchange/Disable-UMIPGateway.md +++ b/exchange/exchange-ps/exchange/Disable-UMIPGateway.md @@ -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/Disconnect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md index d488d21a90..c2a6bb1153 100644 --- a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md @@ -21,8 +21,26 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### DefaultParameterSet (Default) ``` -Disconnect-ExchangeOnline [-Confirm] +Disconnect-ExchangeOnline + [-Confirm] + [-WhatIf] + [] +``` + +### ConnectionId +``` +Disconnect-ExchangeOnline -ConnectionId + [-Confirm] + [-WhatIf] + [] +``` + +### ModulePrefix +``` +Disconnect-ExchangeOnline -ModulePrefix + [-Confirm] [-WhatIf] [] ``` @@ -50,6 +68,20 @@ Disconnect-ExchangeOnline -Confirm:$false 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 -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 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 ### -Confirm @@ -71,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/Enable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md index 7b5320ded3..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://learn.microsoft.com/powershell/module/exchange/enable-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Enable-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -30,7 +30,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-ComplianceTagStorage.md b/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md index af6988e752..c2a69f5215 100644 --- a/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md +++ b/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md @@ -31,7 +31,7 @@ Enable-ComplianceTagStorage ## DESCRIPTION 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 4c46844119..cda305dfb4 100644 --- a/exchange/exchange-ps/exchange/Enable-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Enable-DistributionGroup.md @@ -36,6 +36,8 @@ The Enable-DistributionGroup cmdlet mail-enables existing universal security gro You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or 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 @@ -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. 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 c8f2bddb18..a73b54c47d 100644 --- a/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md @@ -30,7 +30,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-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-MailContact.md b/exchange/exchange-ps/exchange/Enable-MailContact.md index 6fec1bab1a..32afb576cd 100644 --- a/exchange/exchange-ps/exchange/Enable-MailContact.md +++ b/exchange/exchange-ps/exchange/Enable-MailContact.md @@ -96,7 +96,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-MailUser.md b/exchange/exchange-ps/exchange/Enable-MailUser.md index 4b9f859109..0a00e13f2c 100644 --- a/exchange/exchange-ps/exchange/Enable-MailUser.md +++ b/exchange/exchange-ps/exchange/Enable-MailUser.md @@ -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 eb1bdeaebd..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://learn.microsoft.com/powershell/module/exchange/enable-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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,7 +16,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -125,7 +125,7 @@ Enable-Mailbox [-Identity] -LinkedDomainController -L ### Linked ``` -Enable-Mailbox [-Identity] -LinkedDomainController -LinkedMasterAccount +Enable-Mailbox [-Identity] -LinkedDomainController -LinkedMasterAccount [-LinkedCredential ] [-ActiveSyncMailboxPolicy ] [-Alias ] @@ -274,6 +274,8 @@ When mailbox-enabling an existing user, beware of non-supported characters in th You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or 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 @@ -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 @@ -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) @@ -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 @@ -990,7 +992,7 @@ If you don't use this parameter, the default role assignment policy is used. If 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 ac96b23f21..94f1b1b2d7 100644 --- a/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md +++ b/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md @@ -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-OrganizationCustomization.md b/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md index 65cc3b7839..23f178be9e 100644 --- a/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md +++ b/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md @@ -36,7 +36,7 @@ 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. diff --git a/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md b/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md index 2b947c53b8..e23369448c 100644 --- a/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md +++ b/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md @@ -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 3e84717431..e2ca574784 100644 --- a/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md @@ -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/Enable-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md index a7d7239ee2..9bf1aa79ac 100644 --- a/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md +++ b/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md @@ -9,7 +9,6 @@ ms.author: chrisda ms.reviewer: --- - # Enable-ReportSubmissionRule ## SYNOPSIS diff --git a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md index f0109bf999..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://learn.microsoft.com/powershell/module/exchange/enable-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Enable-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -28,7 +28,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-attachments-about). +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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 de303729b4..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://learn.microsoft.com/powershell/module/exchange/enable-safelinksrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Enable-SafeLinksRule schema: 2.0.0 author: chrisda @@ -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-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-TransportRule.md b/exchange/exchange-ps/exchange/Enable-TransportRule.md index 8a9892ab10..4f9a620693 100644 --- a/exchange/exchange-ps/exchange/Enable-TransportRule.md +++ b/exchange/exchange-ps/exchange/Enable-TransportRule.md @@ -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/Execute-AzureADLabelSync.md b/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md index 5aec913120..8da13825b6 100644 --- a/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md +++ b/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md @@ -14,7 +14,7 @@ ms.reviewer: ## 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 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-ActivityExplorerData.md b/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md index 398a15ea73..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://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata -applicable: Exchange Online, Security & Compliance +applicable: Security & Compliance title: Export-ActivityExplorerData schema: 2.0.0 author: chrisda @@ -33,7 +33,136 @@ Export-ActivityExplorerData -EndTime -OutputFormat -StartTim ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/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 @@ -53,10 +182,18 @@ This example exports up to 100 records for the specified date range in Json form ### Example 3 ```powershell -Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -OutputFormat Json -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 @@ -77,20 +214,20 @@ This example exports up to 100 records for the specified date range in JSON form Export-ActivityExplorerData -StartTime "07/06/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -Filter1 @("Activity", "FileArchived", "ArchiveCreated") -Filter2 @("Workload","Endpoint") -OutputFormat Json ``` -This example exports up to 100 records for the specified date range in JSON format, and filters the output by the Workload value 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 @@ -110,7 +247,7 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: csv, json -Applicable: Exchange Online, Security & Compliance +Applicable: Security & Compliance Required: True Position: Named @@ -122,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 @@ -144,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 @@ -168,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 @@ -186,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 @@ -204,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 @@ -222,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 @@ -232,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 @@ -248,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 @@ -271,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 1af047c109..01b6148ebe 100644 --- a/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md +++ b/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md @@ -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 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 df3f7ef23a..0c2de21c86 100644 --- a/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md +++ b/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md @@ -12,9 +12,11 @@ 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. + +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). @@ -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-MailboxDiagnosticLogs.md b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md index ef17891d3a..dada5fa300 100644 --- a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md +++ b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md @@ -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 diff --git a/exchange/exchange-ps/exchange/Export-Message.md b/exchange/exchange-ps/exchange/Export-Message.md index fd2ed02c5b..28b6f435c6 100644 --- a/exchange/exchange-ps/exchange/Export-Message.md +++ b/exchange/exchange-ps/exchange/Export-Message.md @@ -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} ``` diff --git a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md index a0bb5abd1f..f20bb9e7c2 100644 --- a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md @@ -26,7 +26,11 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Export-QuarantineMessage -Identities [-Identity ] [-CompressOutput] + [-EntityType ] [-ForceConversionToMime] + [-Password ] + [-PasswordV2 ] + [-ReasonForExport ] [-RecipientAddress ] [] ``` @@ -35,7 +39,11 @@ Export-QuarantineMessage -Identities [-Identity [-CompressOutput] + [-EntityType ] [-ForceConversionToMime] + [-Password ] + [-PasswordV2 ] + [-ReasonForExport ] [-RecipientAddress ] [] ``` @@ -139,7 +147,28 @@ For exported messages, including messages with attachments, the .zip file contai 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 @@ -157,7 +186,63 @@ This switch has no effect if the message is already encoded as Base64. 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 @@ -173,7 +258,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-ADPermission.md b/exchange/exchange-ps/exchange/Get-ADPermission.md index 96424639d1..773f0467b4 100644 --- a/exchange/exchange-ps/exchange/Get-ADPermission.md +++ b/exchange/exchange-ps/exchange/Get-ADPermission.md @@ -37,7 +37,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md index 7b5fd05725..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://learn.microsoft.com/powershell/module/exchange/get-atpbuiltinprotectionrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ATPBuiltInProtectionRule schema: 2.0.0 author: chrisda @@ -25,7 +25,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 diff --git a/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md index b022dfdb94..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://learn.microsoft.com/powershell/module/exchange/get-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -27,7 +27,7 @@ Get-ATPProtectionPolicyRule [[-Identity] ] ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 171eb3091b..754759eea3 100644 --- a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md +++ b/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md @@ -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 80e573701c..7a46a55884 100644 --- a/exchange/exchange-ps/exchange/Get-AcceptedDomain.md +++ b/exchange/exchange-ps/exchange/Get-AcceptedDomain.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-AcceptedDomain [[-Identity] ] [-DomainController ] + [-ResultSize ] [] ``` @@ -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 8b8c625d1b..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://learn.microsoft.com/powershell/module/exchange/get-accesstocustomerdatarequest -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-AccessToCustomerDataRequest schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -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 @@ -90,7 +90,7 @@ To specify a date/time value for this parameter, use either of the following opt 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-ActiveSyncDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md index 5810a30900..df60827dd4 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -59,6 +59,7 @@ 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 $_} ``` diff --git a/exchange/exchange-ps/exchange/Get-ActivityAlert.md b/exchange/exchange-ps/exchange/Get-ActivityAlert.md deleted file mode 100644 index 5413b3a2af..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://learn.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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.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-AdaptiveScope.md b/exchange/exchange-ps/exchange/Get-AdaptiveScope.md index 9aba30f304..1444986464 100644 --- a/exchange/exchange-ps/exchange/Get-AdaptiveScope.md +++ b/exchange/exchange-ps/exchange/Get-AdaptiveScope.md @@ -12,7 +12,7 @@ ms.reviewer: # Get-AdaptiveScope ## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). +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. @@ -21,11 +21,14 @@ For information about the parameter sets in the Syntax section below, see [Excha ## 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -64,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-AdminAuditLogConfig.md b/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md index 8662763ddb..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://learn.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 +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 @@ -26,7 +26,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md b/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md index 95de2779e2..6a2753ab2d 100644 --- a/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md +++ b/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md @@ -14,9 +14,9 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -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 338cfa3500..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://learn.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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/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://learn.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 b49dc7f6c9..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://learn.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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-attachments-for-spo-odfb-teams-about). - -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://learn.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 1c9c4292b6..90b89266d4 100644 --- a/exchange/exchange-ps/exchange/Get-AgentLog.md +++ b/exchange/exchange-ps/exchange/Get-AgentLog.md @@ -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 56% rename from exchange/exchange-ps/exchange/Get-CsPSTNUsageDetailReport.md rename to exchange/exchange-ps/exchange/Get-AggregateZapReport.md index 56e4f52e18..fd62052590 100644 --- a/exchange/exchange-ps/exchange/Get-CsPSTNUsageDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-AggregateZapReport.md @@ -1,46 +1,40 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.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://learn.microsoft.com/graph/api/resources/report). - -Use the Get-CsPSTNUsageDetailReport cmdlet to view public switched telephone network (PSTN) usage details for Skype for Business Online users. +Use the Get-AggregateZapReport cmdlet to view aggregate information about zero-hour auto purge (ZAP) activity. By default, the cmdlet shows the last three days of activity, but you can specify up to ten days. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-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: - -- SipUri -- DateTimeOfCall -- TelephoneNumber -- CallID -- CallType -- Location -- CallDuration -- Currency -- CallCharge +For the reporting period you specify, the cmdlet returns the following information: + +- Date +- EventType +- ZapActionCount You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -48,43 +42,68 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 80966a24af..332d193a34 100644 --- a/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md @@ -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-App.md b/exchange/exchange-ps/exchange/Get-App.md index a6f89ddb13..4d63102688 100644 --- a/exchange/exchange-ps/exchange/Get-App.md +++ b/exchange/exchange-ps/exchange/Get-App.md @@ -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 8c7695800b..1feb6b2100 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md @@ -23,14 +23,15 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 9c698a100a..b61fb71ac0 100644 --- a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-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 dd791936bb..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://learn.microsoft.com/powershell/module/exchange/get-atppolicyforo365 -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-AtpPolicyForO365 schema: 2.0.0 author: chrisda @@ -30,11 +30,11 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-links-about#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://learn.microsoft.com/microsoft-365/security/office-365-securitysafe-documents-in-e5-plus-security-about). +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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-attachments-for-spo-odfb-teams-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://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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-AuditConfig.md b/exchange/exchange-ps/exchange/Get-AuditConfig.md index 7145316416..65476171dc 100644 --- a/exchange/exchange-ps/exchange/Get-AuditConfig.md +++ b/exchange/exchange-ps/exchange/Get-AuditConfig.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 cbc6955408..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://learn.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://learn.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://learn.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://learn.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 d740a3c4fb..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://learn.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://learn.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://learn.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://learn.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 e736eab8c5..a77201fca0 100644 --- a/exchange/exchange-ps/exchange/Get-AuditLogSearch.md +++ b/exchange/exchange-ps/exchange/Get-AuditLogSearch.md @@ -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-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md index fcf5b6cf45..b79c7d9b3c 100644 --- a/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md +++ b/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md @@ -21,6 +21,8 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-AuthenticationPolicy [[-Identity] ] + [-AllowLegacyExchangeTokens] + [-TenantId ] [] ``` @@ -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 41802bf8f6..b60b6db4da 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md @@ -30,7 +30,7 @@ Get-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -80,7 +80,10 @@ Accept wildcard characters: False ``` ### -ForceValidate -{{ Fill ForceValidate Description }} +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 @@ -96,7 +99,9 @@ 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 5c2f7c611a..ebaea6d9d6 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md index 2407a217a8..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://learn.microsoft.com/powershell/module/exchange/get-availabilityaddressspace -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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 8d04a85ddb..7932aaed30 100644 --- a/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md +++ b/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md @@ -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 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: + +- 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). @@ -27,8 +30,6 @@ 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://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-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-CASMailbox.md b/exchange/exchange-ps/exchange/Get-CASMailbox.md index d52a0a89c9..00439ed122 100644 --- a/exchange/exchange-ps/exchange/Get-CASMailbox.md +++ b/exchange/exchange-ps/exchange/Get-CASMailbox.md @@ -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 diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md index 4ed5fde904..497c465e12 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md @@ -66,6 +66,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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)} ``` diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md index cc538f1283..38b63df96c 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md @@ -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 @@ -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 7f412fdf92..e01ded63d5 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md @@ -22,6 +22,8 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-CalendarDiagnosticObjects [-Identity] + [-AnalyzeExceptionWithOriginalStartDate ] + [-AutoRequeryOnMeetingId ] [-ConfigurationName ] [-CustomPropertyNames ] [-EndDate ] @@ -30,6 +32,7 @@ Get-CalendarDiagnosticObjects [-Identity] [-ExactMatch ] [-ItemClass ] [-ItemIds ] + [-MaxResults ] [-MeetingId ] [-ODataId ] [-ResultSize ] @@ -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 }} @@ -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 aa0f778c18..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://learn.microsoft.com/powershell/module/exchange/get-calendarnotification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-CalendarNotification schema: 2.0.0 author: chrisda @@ -12,9 +12,11 @@ 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. + +**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). @@ -30,7 +32,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -38,29 +40,15 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 @@ -95,7 +83,7 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com 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-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md index 09f853dfee..54654c842b 100644 --- a/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md @@ -16,8 +16,6 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info 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) or Azure managed identity. - For 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 b7613cecb8..632e20fe65 100644 --- a/exchange/exchange-ps/exchange/Get-CaseHoldRule.md +++ b/exchange/exchange-ps/exchange/Get-CaseHoldRule.md @@ -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://learn.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-ClientAccessRule.md b/exchange/exchange-ps/exchange/Get-ClientAccessRule.md index db5fa3b4f4..0e40aa0d98 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Get-ClientAccessRule.md @@ -12,6 +12,9 @@ ms.reviewer: # Get-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 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. diff --git a/exchange/exchange-ps/exchange/Get-Clutter.md b/exchange/exchange-ps/exchange/Get-Clutter.md index 960fd3b0b2..abd9f70458 100644 --- a/exchange/exchange-ps/exchange/Get-Clutter.md +++ b/exchange/exchange-ps/exchange/Get-Clutter.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-Clutter -Identity + [-UseCustomRouting] [] ``` @@ -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-ComplianceCase.md b/exchange/exchange-ps/exchange/Get-ComplianceCase.md index 705de6a1cf..74d35075bf 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceCase.md @@ -16,8 +16,6 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info 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) or Azure managed identity. - For 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 134a8c9050..5588971c20 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 e43224610e..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://learn.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 @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 6dbc6330cd..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://learn.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 diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md b/exchange/exchange-ps/exchange/Get-ComplianceSearch.md index dded9847d9..95ca1983f2 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSearch.md @@ -33,7 +33,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 eee4431b3f..a0ca0a62b5 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md @@ -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 ] [] ``` @@ -71,7 +75,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 6893638c8b..0c3ff1f88a 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 e93c18f854..2c704b8488 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceTag.md @@ -23,11 +23,12 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 41ed2c128a..c3aa8eaca3 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md @@ -22,11 +22,12 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 4ae0950a48..d26e9e5e0d 100644 --- a/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md +++ b/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -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 551293207c..07d5d63148 100644 --- a/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -43,7 +43,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 64f10746a8..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://learn.microsoft.com/powershell/module/exchange/get-configanalyzerpolicyrecommendation -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ConfigAnalyzerPolicyRecommendation schema: 2.0.0 author: chrisda @@ -28,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://learn.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 708971fd86..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://learn.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://learn.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://learn.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://learn.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 47d29674f6..97f9d3efd2 100644 --- a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md +++ b/exchange/exchange-ps/exchange/Get-ConnectionInformation.md @@ -13,7 +13,7 @@ ms.reviewer: # Get-ConnectionInformation ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell module v2.0.6-Preview7 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). +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. @@ -21,13 +21,46 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### Default (Default) ``` Get-ConnectionInformation [] ``` +### ConnectionId +``` +Get-ConnectionInformation -ConnectionId [] +``` + +### ModulePrefix +``` +Get-ConnectionInformation -ModulePrefix [] +``` + ## DESCRIPTION The Get-ConnectionInformation cmdlet returns the information about all active REST-based connections with Exchange Online in the current PowerShell instance. This cmdlet is equivalent to the Get-PSSession cmdlet that's used with remote PowerShell sessions. +The output of the cmdlet contains the following properties: + +- ConnectionId: A unique GUID value for the connection. For example, 8b632b3a-a2e2-8ff3-adcd-6d119d07694b. +- State: For example, Connected. +- Id: An integer that identifies the session in the PowerShell window. The first connection is 1, the second is 2, etc. +- Name: A unique name that's based on the PowerShell environment and Id value. For example, ExchangeOnline_1 for Exchange Online PowerShell or ExchangeOnlineProtection_1 for Security & Compliance PowerShell. +- UserPrincipalName: The account that was used to connect. For example, `laura@contoso.onmicrosoft.com`. +- ConnectionUri: The connection endpoint that was used. For example, `https://outlook.office365.com` for Exchange Online PowerShell or `https://nam12b.ps.compliance.protection.outlook.com` for Security & Compliance PowerShell. +- AzureAdAuthorizationEndpointUri : The Microsoft Entra authorization endpoint for the connection. For example, `https://login.microsoftonline.com/organizations` for Exchange Online PowerShell or `https://login.microsoftonline.com/organizations` for Security & Compliance PowerShell. +- TokenExpiryTimeUTC: When the connection token expires. For example, 9/30/2023 6:42:24 PM +00:00. +- CertificateAuthentication: Whether certificate based authentication (also known as CBA or app-only authentication) was used to connect. Values are True or False. +- ModuleName: The filename and path of the temporary data for the session. For example, C:\Users\laura\AppData\Local\Temp\tmpEXO_a54z135k.qgv +- ModulePrefix: The value specified using the Prefix parameter in the Connect-ExchangeOnline or Connect-IPPSSession command. +- Organization: The value specified using the Organization parameter in the Connect-ExchangeOnline or Connect-IPPSSession command for CBA or managed identity connections. +- DelegatedOrganization: The value specified using the DelegatedOrganization parameter in the Connect-ExchangeOnline or Connect-IPPSSession command. +- AppId: The value specified using the AppId parameter in the Connect-ExchangeOnline or Connect-IPPSSession command for CBA connections. +- PageSize: The default maximum number of entries per page in the connection. The default value is 1000, or you can use the PageSize parameter in the Connect-ExchangeOnline command to specify a lower number. Individual cmdlets might also have a PageSize parameter. +- TenantID: The tenant ID GUID value. For example, 3750b40b-a68b-4632-9fb3-5b1aff664079. +- TokenStatus: For example, Active. +- ConnectionUsedForInbuiltCmdlets +- IsEopSession: For Exchange Online PowerShell connections, the value is False. For Security & Compliance PowerShell connections, the value is True. + ## EXAMPLES ### Example 1 @@ -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-ContentMalwareMdoAggregateReport.md b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md index ac7a2727cf..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://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdoaggregatereport -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ContentMalwareMdoAggregateReport schema: 2.0.0 author: chrisda @@ -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 8003e096b3..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://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdodetailreport -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ContentMalwareMdoDetailReport schema: 2.0.0 author: chrisda @@ -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 22d7b17eea..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://learn.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://learn.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://learn.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://learn.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 4eda0c2b07..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://learn.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://learn.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://learn.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://learn.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 d39ca65991..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://learn.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://learn.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://learn.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://learn.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 745071ab4e..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://learn.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://learn.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://learn.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://learn.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 2291fdc8b5..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://learn.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://learn.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://learn.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://learn.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 2ad481da9d..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://learn.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://learn.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://learn.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://learn.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 0dd14539b1..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://learn.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://learn.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://learn.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://learn.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 63c8e5ad46..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://learn.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://learn.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://learn.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://learn.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 798dd27773..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://learn.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://learn.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://learn.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://learn.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 82584f949b..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://learn.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://learn.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://learn.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://learn.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-DataRetentionReport.md b/exchange/exchange-ps/exchange/Get-DataRetentionReport.md index fb5eceeb59..1f38d8c687 100644 --- a/exchange/exchange-ps/exchange/Get-DataRetentionReport.md +++ b/exchange/exchange-ps/exchange/Get-DataRetentionReport.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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,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". The StartDate value can't be older than 92 days from today. 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-MailboxUsageReport.md b/exchange/exchange-ps/exchange/Get-DetailZapReport.md similarity index 54% rename from exchange/exchange-ps/exchange/Get-MailboxUsageReport.md rename to exchange/exchange-ps/exchange/Get-DetailZapReport.md index eef9eefee7..e2332bf377 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxUsageReport.md +++ b/exchange/exchange-ps/exchange/Get-DetailZapReport.md @@ -1,78 +1,120 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxusagereport +online version: https://learn.microsoft.com/powershell/module/exchange/get-detailzapreport applicable: Exchange Online -title: Get-MailboxUsageReport +title: Get-DetailZapReport schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: --- -# Get-MailboxUsageReport +# Get-DetailZapReport ## 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://learn.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. +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-MailboxUsageReport [-EndDate ] - [-ResultSize ] - [-StartDate ] +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-MailboxUsageReport -StartDate 06/13/2015 -EndDate 06/15/2015 +Get-DetailZapReport ``` -This example retrieves the number of mailboxes that were near or over the maximum mailbox size between June 13, 2015 and June 15, 2015. +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, or you can enter the date and time of 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 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: 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 ``` @@ -80,18 +122,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 ``` @@ -100,14 +144,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - ## OUTPUTS -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and 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-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md index 02acd9fcb4..a79926c166 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md @@ -35,7 +35,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 5a30a9530b..65fe845674 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md @@ -37,7 +37,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 21796b371c..34e6dc1ae0 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md @@ -35,7 +35,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 71ccb600ac..84afa08d75 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md @@ -37,7 +37,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 accdcab7f5..f7cb5c1dce 100644 --- a/exchange/exchange-ps/exchange/Get-DevicePolicy.md +++ b/exchange/exchange-ps/exchange/Get-DevicePolicy.md @@ -35,7 +35,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 edcc7912c2..ce5c1c516e 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md @@ -35,7 +35,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 7aa1000a9f..3d61488bdc 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md +++ b/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md @@ -36,7 +36,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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-DistributionGroup.md b/exchange/exchange-ps/exchange/Get-DistributionGroup.md index a99638dd42..601c6b2a36 100644 --- a/exchange/exchange-ps/exchange/Get-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Get-DistributionGroup.md @@ -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] @@ -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 750b431bd8..3113e769e2 100644 --- a/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md @@ -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 diff --git a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md index 08e329ee18..f5a379ed1b 100644 --- a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md @@ -22,15 +22,19 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-DlpCompliancePolicy [[-Identity] ] - [-ForceValidate ] + [-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 +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 @@ -85,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) @@ -133,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 c34e03a9c3..3ec06ed550 100644 --- a/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md @@ -22,13 +22,14 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 87216aec5c..ec4460246a 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpDetailReport.md @@ -12,9 +12,11 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -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 c8d5b8494d..be1c5ba605 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md @@ -14,7 +14,9 @@ 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. + +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). @@ -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 c43adc876a..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://learn.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 @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.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 index 017c85474d..59707c5464 100644 --- a/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Get-DlpEdmSchema +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpincidentdetailsreport applicable: Exchange Online, Security & Compliance title: Get-DlpIncidentDetailReport schema: 2.0.0 @@ -14,6 +14,8 @@ ms.reviewer: ## 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). @@ -155,7 +157,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 @@ -233,8 +235,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 - TEAMS You can specify multiple values separated by commas. @@ -255,7 +257,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-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md index b72a6ded1a..cf21bb85d5 100644 --- a/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 47fa00ca4d..ef75ad1628 100644 --- a/exchange/exchange-ps/exchange/Get-DlpPolicy.md +++ b/exchange/exchange-ps/exchange/Get-DlpPolicy.md @@ -12,9 +12,11 @@ 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. + +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). @@ -23,7 +25,6 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-DlpPolicy [[-Identity] ] [-DomainController ] - [-ForceValidate ] [] ``` @@ -69,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 @@ -86,22 +85,6 @@ 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 -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md index 417ddcb69b..bafb90d765 100644 --- a/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md @@ -12,9 +12,11 @@ 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. + +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). diff --git a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md index e8c3170dfa..99d0a14db7 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 f9eb2ccd04..b89d2416f2 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md @@ -14,6 +14,8 @@ ms.reviewer: ## 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 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 3a52eefa05..b36194819e 100644 --- a/exchange/exchange-ps/exchange/Get-DomainController.md +++ b/exchange/exchange-ps/exchange/Get-DomainController.md @@ -46,6 +46,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell $UserCredentials = Get-Credential + Get-DomainController -DomainName corp.contoso.com -Credential $UserCredentials | Format-Table -AutoSize Name,ADSite ``` diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md index e75edd9886..d988b7788e 100644 --- a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md @@ -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] @@ -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 ``` @@ -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 4c718b5040..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://learn.microsoft.com/powershell/module/exchange/get-dynamicdistributiongroupmember -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-DynamicDistributionGroupMember schema: 2.0.0 author: chrisda @@ -58,7 +58,7 @@ The Identity parameter specifies the dynamic distribution group. You can use any Type: DynamicDistributionGroupMemberIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 0 @@ -76,7 +76,7 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -94,7 +94,7 @@ Soft-deleted group members are deleted Microsoft 365 Groups or mailboxes that ar Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -110,7 +110,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-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md index 76b642f228..6ca809c445 100644 --- a/exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md @@ -27,7 +27,7 @@ Get-EOPProtectionPolicyRule [[-Identity] ] ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md b/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md index 7da70215f4..72e7aca6f2 100644 --- a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md +++ b/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md @@ -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. diff --git a/exchange/exchange-ps/exchange/Get-EXOMailbox.md b/exchange/exchange-ps/exchange/Get-EXOMailbox.md index 28a48b29c1..fb1295de5f 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailbox.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailbox.md @@ -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. diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md index af9dc4dad4..d15ff5ab3c 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md @@ -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. diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md index c04e32c503..b6d21cf8d8 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md @@ -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. diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md b/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md index 617bbf79ac..d008aa8f24 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md @@ -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. diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md b/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md index b946cbda45..cbe03cc816 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md @@ -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 diff --git a/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md index 9749cbe74f..91b5ebab64 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md +++ b/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md @@ -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 7322ad3f90..fd34b10f9d 100644 --- a/exchange/exchange-ps/exchange/Get-EXORecipient.md +++ b/exchange/exchange-ps/exchange/Get-EXORecipient.md @@ -15,7 +15,7 @@ ms.reviewer: ## SYNOPSIS 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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. diff --git a/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md b/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md index fe19464913..3ec37b7a9d 100644 --- a/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md +++ b/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md @@ -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. diff --git a/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md b/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md index 2c87354ba5..fe9c386e7f 100644 --- a/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md +++ b/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md @@ -121,7 +121,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Get-EmailAddressPolicy.md index 2cc4b35ebf..1cb8b5a7a3 100644 --- a/exchange/exchange-ps/exchange/Get-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/Get-EmailAddressPolicy.md @@ -14,7 +14,7 @@ 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-EmailAddressPolicy cmdlet to view email address policies. In Exchange Online, email address policies are only available for Microsoft 365 Groups. +Use the Get-EmailAddressPolicy cmdlet to view 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Get-EtrLimits.md b/exchange/exchange-ps/exchange/Get-EtrLimits.md new file mode 100644 index 0000000000..759a8d045c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EtrLimits.md @@ -0,0 +1,50 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-etrlimits +applicable: Exchange Online, Exchange Online Protection +title: Get-EtrLimits +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-EtrLimits + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-EtrLimits cmdlet to show information about [mail flow rule (also known as transport rule) limits in Exchange Online](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#journal-transport-and-inbox-rule-limits), as well the current usage and the largest rule IDs in terms of size and regular expression character count. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-EtrLimits [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-EtrLimits +``` + +This example returns information about the number and size of mail flow rules in the organization, and the organizational limits for mail flow rules. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md b/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md index 630ca5bd2a..30df67b8a5 100644 --- a/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md @@ -12,7 +12,7 @@ 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. diff --git a/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md b/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md index 6e246ecedb..ca36c14478 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md @@ -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-ExoInformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md index 7e95b4ce4f..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://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierpolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ExoInformationBarrierPolicy schema: 2.0.0 author: chrisda @@ -21,7 +21,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Get-ExoInformationBarrierPolicy [[-Identity] ] [-ShowFriendlyValues] [] +Get-ExoInformationBarrierPolicy [[-Identity] ] [-ShowFriendlyValues] [] ``` ## DESCRIPTION @@ -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 3d9d498c3d..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://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierrelationship -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ExoInformationBarrierRelationship schema: 2.0.0 author: chrisda @@ -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 608a5bd12c..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://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarriersegment -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-ExoInformationBarrierSegment schema: 2.0.0 author: chrisda @@ -57,7 +57,7 @@ The Identity parameter specifies the Exchange Online information barrier segment Type: InformationBarrierSegmentIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 0 @@ -75,7 +75,7 @@ When you use this switch, the FriendlyMembershipFilter property value is 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-PhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md similarity index 58% rename from exchange/exchange-ps/exchange/Get-PhishSimOverrideRule.md rename to exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md index 9c1392a2f1..0baced66e2 100644 --- a/exchange/exchange-ps/exchange/Get-PhishSimOverrideRule.md +++ b/exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md @@ -1,44 +1,54 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-phishsimoverriderule -applicable: Exchange Online, Security & Compliance -title: Get-PhishSimOverrideRule +online version: https://learn.microsoft.com/powershell/module/exchange/get-exophishsimoverriderule +applicable: Exchange Online +title: Get-ExoPhishSimOverrideRule schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: --- -# Get-PhishSimOverrideRule +# Get-ExoPhishSimOverrideRule ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -Use the Get-PhishSimOverrideRule cmdlet to view third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +Use the Get-ExoPhishSimOverrideRule cmdlet to view third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-PhishSimOverrideRule [[-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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 58% rename from exchange/exchange-ps/exchange/Get-SecOpsOverrideRule.md rename to exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md index 9f6d92fc5a..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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +Use the Get-ExoSecOpsOverrideRule cmdlet to view SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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-FailedContentIndexDocuments.md b/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md index 050abe3a2e..14df25198f 100644 --- a/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md +++ b/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md @@ -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/Remove-ActivityAlert.md b/exchange/exchange-ps/exchange/Get-FeatureConfiguration.md similarity index 56% rename from exchange/exchange-ps/exchange/Remove-ActivityAlert.md rename to exchange/exchange-ps/exchange/Get-FeatureConfiguration.md index 32ccb9a2e7..87063ff596 100644 --- a/exchange/exchange-ps/exchange/Remove-ActivityAlert.md +++ b/exchange/exchange-ps/exchange/Get-FeatureConfiguration.md @@ -1,49 +1,58 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-activityalert +online version: https://learn.microsoft.com/powershell/module/exchange/get-featureconfiguration applicable: Security & Compliance -title: Remove-ActivityAlert +title: Get-FeatureConfiguration schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: --- -# Remove-ActivityAlert +# 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). -Use the Remove-ActivityAlert cmdlet to remove activity alerts from the Microsoft 365 Defender portal or the Microsoft Purview compliance portal. +> [!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 ``` -Remove-ActivityAlert [-Identity] +Get-FeatureConfiguration [[-Identity] ] [-FeatureScenario] [-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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-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 -Remove-ActivityAlert -Identity "All Mailbox Activities" +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 removes the activity alert named All Mailbox Activities. +This example returns detailed information about the specified collection policy. ## 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: +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) @@ -55,39 +64,38 @@ Parameter Sets: (All) Aliases: Applicable: Security & Compliance -Required: True +Required: False Position: 1 Default value: None -Accept pipeline input: True +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. +### -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: SwitchParameter +Type: PolicyScenario Parameter Sets: (All) -Aliases: cf +Aliases: Applicable: Security & Compliance -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ForceDeletion +### -Confirm This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: Security & Compliance Required: False @@ -98,7 +106,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md index 874aac7d5f..ed2bc3113e 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md @@ -11,7 +11,7 @@ schema: 2.0.0 ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Get-FocusedInbox.md b/exchange/exchange-ps/exchange/Get-FocusedInbox.md index 180a9570ed..c7b5967c67 100644 --- a/exchange/exchange-ps/exchange/Get-FocusedInbox.md +++ b/exchange/exchange-ps/exchange/Get-FocusedInbox.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-FocusedInbox -Identity + [-UseCustomRouting] [] ``` @@ -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-Group.md b/exchange/exchange-ps/exchange/Get-Group.md index 775265b13e..b940181519 100644 --- a/exchange/exchange-ps/exchange/Get-Group.md +++ b/exchange/exchange-ps/exchange/Get-Group.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Get-GroupActivityReport.md b/exchange/exchange-ps/exchange/Get-GroupActivityReport.md deleted file mode 100644 index 52efb48945..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://learn.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://learn.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://learn.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://learn.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-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md index ae54c3ebe8..ec353acb7a 100644 --- a/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md index 7c75a0cef9..898c6c476a 100644 --- a/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-HybridMailflow.md b/exchange/exchange-ps/exchange/Get-HybridMailflow.md deleted file mode 100644 index ee88ca9d87..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://learn.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://learn.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-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-InboundConnector.md b/exchange/exchange-ps/exchange/Get-InboundConnector.md index 50645c8e72..2447b733ef 100644 --- a/exchange/exchange-ps/exchange/Get-InboundConnector.md +++ b/exchange/exchange-ps/exchange/Get-InboundConnector.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-InboundConnector [[-Identity] ] + [-ResultSize ] [] ``` @@ -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 070c4b4092..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://learn.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 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-InboxRule schema: 2.0.0 author: chrisda @@ -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://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 b1ff7e7a16..4ba383b667 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md +++ b/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md @@ -34,9 +34,9 @@ Get-InformationBarrierPoliciesApplicationStatus [[-Identity] ``` ## DESCRIPTION - For more information, see [View status of information barrier policy application](https://learn.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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.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 8a9a856de8..32c2276297 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md @@ -34,9 +34,9 @@ Get-InformationBarrierPolicy [[-Identity] ] ``` ## DESCRIPTION -For more information, see [Information barrier policies](https://learn.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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) [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 6970c498d5..862519808e 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md +++ b/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md @@ -16,6 +16,8 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Get-InformationBarrierRecipientStatus cmdlet to return information about recipients and their relationship to information barrier policies. +**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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.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://learn.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) [New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-Label.md b/exchange/exchange-ps/exchange/Get-Label.md index e7a6d7c4ad..b2cf3b4226 100644 --- a/exchange/exchange-ps/exchange/Get-Label.md +++ b/exchange/exchange-ps/exchange/Get-Label.md @@ -22,13 +22,14 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 0b6663dc9e..7a90fbaa71 100644 --- a/exchange/exchange-ps/exchange/Get-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Get-LabelPolicy.md @@ -27,7 +27,7 @@ Get-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md index 5ebaee0b63..c7992e4955 100644 --- a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md @@ -29,7 +29,7 @@ Get-M365DataAtRestEncryptionPolicy [[-Identity] ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-ReadFromDomainController] [-ResultSize ] [-Server ] @@ -40,6 +41,7 @@ Get-MailPublicFolder [[-Identity] ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-ReadFromDomainController] [-ResultSize ] [-Server ] @@ -196,6 +198,24 @@ 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: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ReadFromDomainController This parameter is available only in on-premises Exchange. diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md index f0fcf12de2..b18dc3f97a 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md @@ -35,6 +35,7 @@ Get-MailTrafficATPReport [-ProbeTag ] [-StartDate ] [-SummarizeBy ] + [-ThreatClassification ] [] ``` @@ -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 @@ -145,7 +152,7 @@ To specify a date/time value for this parameter, use either of the following opt - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". - Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). -If you use 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"`. @@ -289,7 +296,7 @@ To specify a date/time value for this parameter, use either of the following opt - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". - Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). -If you use 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 a7188c82d5..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://learn.microsoft.com/powershell/module/exchange/get-mailtrafficencryptionreport -applicable: Exchange Online, Security & Compliance +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-MailTrafficEncryptionReport schema: 2.0.0 author: chrisda @@ -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 0dde747a2f..f1ab603a7f 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md @@ -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 bd490c2dd2..5ef4d9692a 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md @@ -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 f0262358be..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://learn.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://learn.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://learn.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://learn.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 525b0b7bd3..acaf5fe057 100644 --- a/exchange/exchange-ps/exchange/Get-MailUser.md +++ b/exchange/exchange-ps/exchange/Get-MailUser.md @@ -52,6 +52,31 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -127,7 +152,7 @@ This parameter requires the creation and passing of a credential object. This cr ```yaml Type: PSCredential -Parameter Sets: (All) +Parameter Sets: AnrSet, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -145,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 @@ -181,6 +206,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: LOBAppAccount +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. @@ -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 6442b32a40..cae3773fe1 100644 --- a/exchange/exchange-ps/exchange/Get-Mailbox.md +++ b/exchange/exchange-ps/exchange/Get-Mailbox.md @@ -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 ] @@ -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. @@ -762,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 ff13d11f0d..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://learn.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://learn.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://learn.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://learn.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 b87797416b..52e699b66f 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md +++ b/exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md @@ -51,6 +51,7 @@ This example returns the status of the AuditBypassEnabled property for the Svc-M ### Example 3 ```powershell $MBX = Get-MailboxAuditBypassAssociation -ResultSize unlimited + $MBX | where {$_.AuditBypassEnabled -eq $true} | Format-Table Name,AuditBypassEnabled ``` diff --git a/exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md index b88e648641..2eaf391e3c 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxAutoReplyConfiguration.md @@ -26,6 +26,7 @@ Get-MailboxAutoReplyConfiguration [-Identity] [-DomainController ] [-ReadFromDomainController] [-ResultSize ] + [-UseCustomRouting] [] ``` @@ -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 74d4f2ed6a..d8966ce18e 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md @@ -20,7 +20,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX -### Default +### Default ``` Get-MailboxCalendarConfiguration [-Identity] [-DomainController ] [] diff --git a/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md index 60f0c71404..075437cc2c 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md +++ b/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-MailboxCalendarFolder [-Identity] + [-UseCustomRouting] [-DomainController ] [] ``` @@ -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-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md index db5a9f827b..1873b6abc7 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md @@ -25,8 +25,11 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-MailboxFolderPermission [-Identity] [-DomainController ] - [-User ] [-GroupMailbox] + [-ResultSize ] + [-SkipCount ] + [-UseCustomRouting] + [-User ] [] ``` @@ -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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md index f6525426a6..8b201910e4 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md @@ -34,6 +34,7 @@ Get-MailboxFolderStatistics [-Identity] [-IncludeSoftDeletedRecipients] [-ResultSize ] [-SkipCount ] + [-UseCustomRouting] [] ``` @@ -105,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} ``` @@ -386,6 +388,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-MailboxIRMAccess.md b/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md index 698a24d790..ca07bcdfd7 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md +++ b/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md @@ -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-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md index a6a93b348d..bc4b367757 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md @@ -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 ``` diff --git a/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md index 99a582a508..fff93d6e2a 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md @@ -26,6 +26,8 @@ Get-MailboxMessageConfiguration [-Identity] [-DomainController ] [-ReadFromDomainController] [-ResultSize ] + [-SignatureName ] + [-UseCustomRouting] [] ``` @@ -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 63248c825f..80fc4e6f73 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxPermission.md +++ b/exchange/exchange-ps/exchange/Get-MailboxPermission.md @@ -28,8 +28,10 @@ Get-MailboxPermission [-Identity] [-Owner] [-Credential ] [-DomainController ] [-GroupMailbox] + [-IncludeUserWithDisplayName] [-ReadFromDomainController] [-ResultSize ] + [-UseCustomRouting] [] ``` @@ -41,8 +43,10 @@ Get-MailboxPermission [-Identity] [-User ] + [-UseCustomRouting] [] ``` @@ -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-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md index ef86b1240c..0915467f52 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md @@ -20,10 +20,23 @@ For information about the parameter sets in the Syntax section below, see [Excha ## 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] [] ``` @@ -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 742a52d164..d247baf12a 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md @@ -58,6 +58,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 ``` diff --git a/exchange/exchange-ps/exchange/Get-MailboxSearch.md b/exchange/exchange-ps/exchange/Get-MailboxSearch.md index 98f855d594..3051b480ef 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Get-MailboxSearch.md @@ -16,7 +16,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -74,6 +74,7 @@ The Identity parameter is a positional parameter. Positional parameters can be u ### Example 3 ```powershell (Get-Mailbox Mark).InPlaceHolds + Get-MailboxSearch -InPlaceHoldIdentity 9953d0f0fd03415e949d4b41c5a28cbb ``` diff --git a/exchange/exchange-ps/exchange/Get-MailboxStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxStatistics.md index a10cb31e3b..364729d637 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxStatistics.md @@ -46,6 +46,7 @@ Get-MailboxStatistics [-Identity] [-IncludeQuarantineDetails] [-IncludeSoftDeletedRecipients] [-NoADLookup] + [-UseCustomRouting] [] ``` @@ -71,6 +72,8 @@ 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. +**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 ``` @@ -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-MailboxUsageDetailReport.md b/exchange/exchange-ps/exchange/Get-MailboxUsageDetailReport.md deleted file mode 100644 index 1dbb596629..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://learn.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://learn.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://learn.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://learn.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-MailflowStatusReport.md b/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md index 52ab948d23..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://learn.microsoft.com/powershell/module/exchange/get-mailflowstatusreport -applicable: Exchange Online -title: 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-MailflowStatusReport +Get-MailFlowStatusReport [-Direction ] [-Domain ] [-EndDate ] @@ -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-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md index 36315cd2fe..574baae033 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md @@ -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 ] @@ -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 24f4639d27..8ba8cccb05 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md +++ b/exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md @@ -25,6 +25,7 @@ Get-ManagementRoleEntry [-Identity] [-DomainController ] [-Parameters ] [-PSSnapinName ] + [-ResultSize ] [-Type ] [] ``` @@ -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-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md index 29d990c50d..77a025f2c7 100644 --- a/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md @@ -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-MessageTrace.md b/exchange/exchange-ps/exchange/Get-MessageTrace.md index 94395d03c8..fa030fd3a1 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrace.md +++ b/exchange/exchange-ps/exchange/Get-MessageTrace.md @@ -14,6 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. +> [!NOTE] +> This cmdlet is replaced by the [Get-MessageTraceV2](https://learn.microsoft.com/powershell/module/exchange/get-messagetracev2) cmdlet and will eventually be deprecated. + 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -64,7 +67,7 @@ This example retrieves message trace information for messages sent by john@conto ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -218,7 +221,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md b/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md index 2d9a955061..2053d79a67 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md +++ b/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetail -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-MessageTraceDetail schema: 2.0.0 author: chrisda @@ -14,6 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. +> [!NOTE] +> This cmdlet is replaced by the [Get-MessageTraceDetailV2](https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetailv2) cmdlet and will eventually be deprecated. + 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -74,7 +77,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 +93,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 +111,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -120,7 +123,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 +131,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 +157,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -170,7 +173,7 @@ The MessageId parameter filters the results by the Message-ID header field of th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -186,7 +189,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -202,7 +205,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -218,7 +221,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -234,7 +237,7 @@ The SenderAddress parameter filters the results by the sender's email address. Y Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -246,7 +249,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 +257,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..78e1a37969 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MessageTraceDetailV2.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetailv2 +applicable: Exchange Online +title: Get-MessageTraceDetailV2 +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MessageTraceDetailV2 + +## SYNOPSIS + +## SYNTAX + +``` +Get-MessageTraceDetailV2 [-MessageTraceId] [-RecipientAddress] + [[-Action] ] + [[-EndDate] ] + [[-Event] ] + [[-MessageId] ] + [[-SenderAddress] ] + [[-StartDate] ] + [] +``` + +## DESCRIPTION +You can use this cmdlet to search message data for the last 90 days. You can only query 10 days worth of data per query. If you enter a timeframe that's older than 90 days, you receive an error and the command will return no results. + +Throttling limit: A maximum of 100 query requests will be accepted within 5 minutes running window. Throttling is automatically not applied if the request rate is lower than 100 requests in the past 5 minutes + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MessageTraceDetailV2 -MessageTraceId ae5c1219-4c90-41bf-fef5-08d837917e7c -RecipientAddress robert@contoso.com +``` + +This example retrieves detailed message trace information for messages with the message trace ID value ae5c1219-4c90-41bf-fef5-08d837917e7c that were received by `robert@contoso.com`. + +### Example 2 +```powershell +Get-MessageTraceV2 -MessageTraceId 2bbad36aa4674c7ba82f4b307fff549f -SenderAddress john@contoso.com -StartDate 06/13/2025 -EndDate 06/15/2025 | Get-MessageTraceDetailV2 +``` + +This example uses the Get-MessageTraceV2 cmdlet to retrieve message trace information for messages with the Exchange Network Message ID value 2bbad36aa4674c7ba82f4b307fff549f sent by `john@contoso.com` between June 13, 2025 and June 15, 2025, and pipelines the results to the Get-MessageTraceDetailV2 cmdlet. + +## PARAMETERS + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Action +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Event +The Event parameter filters the report by the message event. The following are examples of common events: + +- RECEIVE: The message was received by the service. +- SEND: The message was sent by the service. +- FAIL: The message failed to be delivered. +- DELIVER: The message was delivered to a mailbox. +- EXPAND: The message was sent to a distribution group that was expanded. +- TRANSFER: Recipients were moved to a bifurcated message because of content conversion, message recipient limits, or agents. +- DEFER: The message delivery was postponed and may be re-attempted later. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SenderAddress +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceV2.md b/exchange/exchange-ps/exchange/Get-MessageTraceV2.md new file mode 100644 index 0000000000..f356876da6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MessageTraceV2.md @@ -0,0 +1,321 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracev2 +applicable: Exchange Online +title: Get-MessageTraceV2 +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MessageTraceV2 + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MessageTraceV2 cmdlet to trace messages as they pass through the cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MessageTraceV2 + [[-EndDate] ] + [[-FromIP] ] + [[-MessageId] ] + [[-MessageTraceId] ] + [[-RecipientAddress] ] + [[-ResultSize] ] + [[-SenderAddress] ] + [[-StartDate] ] + [[-StartingRecipientAddress] ] + [[-Status] ] + [[-SubjectFilterType] ] + [[-Subject] ] + [[-ToIP] ] + [] +``` + +## DESCRIPTION +You can use this cmdlet to search message data for the last 90 days. If you run this cmdlet without any parameters, only data from the last 48 hours is returned. You can only return 10 days worth of data per query. + +By default, this cmdlet returns up to 1000 results, with a maximum of 5000 results. If your data exceeds the result size, query in multiple rounds or use smaller StartDate and EndDate intervals. + +The time stamps on the output are in UTC time format. That might be different from the time format that you used for the -StartDate and the -EndDate parameters. + +Throttling limit: A maximum of 100 query requests will be accepted within 5 minutes running window. Throttling is automatically not applied if the request rate is lower than 100 requests in the past 5 minutes + +Pagination isn't supported in this cmdlet. To query subsequent data, use the StartingRecipientAddress and EndDate parameters with the values from the **Recipient address** and **Received Time** properties respectively of the previous result in the next query. + +Best Practices: + +- Use the ResultSize parameter to adjust the size of your results. +- Be as precise as possible. Narrow the gap between StartDate and EndDate and use additional parameters (for example, SenderAddress) where possible. +- Use MessageTraceId where possible (required for messages sent to more than 1000 recipients). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MessageTraceV2 -SenderAddress john@contoso.com -StartDate 06/13/2025 -EndDate 06/15/2025 +``` + +This example retrieves message trace information for messages sent by `john@contoso.com` between June 13, 2025 and June 15, 2025. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FromIP +The FromIP parameter filters the results by the source IP address. For incoming messages, the value of FromIP is the public IP address of the SMTP email server that sent the message. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailDlpPolicyReport +- Get-MailDetailEncryptionReport +- Get-MailDetailTransportRuleReport +- Get-MessageTraceDetailV2 + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. A valid value is from 1 to 5000. The default value is 1000. + +**Note**: This parameter replaces the PageSize parameter that was available on the Get-MessageTrace cmdlet. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 6 +Default value: 0 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SenderAddress +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartingRecipientAddress +The StartingRecipientAddress parameter is used with the EndDate parameter to query subsequent data for partial results while avoiding duplication. Query subsequent data by taking the **Recipient address** and **Received Time** values of the last record of the partial results and using them as the values for the StartingRecipientAddress and EndDate parameters respectively in the next query. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +The Status parameter filters the results by the delivery status of the message. Valid values are: + +- Delivered: The message was delivered to its destination. +- Expanded: There was no message delivery because the message was addressed to a distribution group and the membership of the distribution was expanded. +- Failed: Message delivery was attempted and it failed. +- FilteredAsSpam: The message was marked as spam. +- GettingStatus: The message is waiting for status update. +- None: The message has no delivery status because it was rejected or redirected to a different recipient. +- Pending: Message delivery is underway or was deferred and is being retried. +- Quarantined: The message was quarantined. + +You can separate multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject +The Subject parameter filters the results by the subject of the message. If the value contains spaces, enclose the value in quotation marks ("). + +You specify how the value is evaluated in the message subject by using the SubjectFilterType parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 11 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectFilterType +The SubjectFilterType parameter specifies how the value of the Subject parameter is evaluated. Valid values are: + +- Contains +- EndsWith +- StartsWith + +We recommend using StartsWith or EndsWith instead of Contains whenever possible. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 12 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ToIP +The ToIP parameter filters the results by the destination IP address. For outgoing messages, the value of ToIP is the public IP address in the resolved MX record for the destination domain. For incoming messages to Exchange Online, the value is blank. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 13 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md b/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md index 9f8f2c445e..877d2fd0a3 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md +++ b/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md @@ -59,10 +59,17 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 diff --git a/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md b/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md index 9a67fb0e1e..fe0eb16c93 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md +++ b/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md @@ -16,7 +16,7 @@ This cmdlet is functional only in on-premises Exchange. Use the Get-MessageTrackingReport cmdlet to return data for a specific message tracking report. This cmdlet is used by the delivery reports feature. -In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail cmdlets). +In Exchange Online, delivery reports are replaced by message trace (the Get-MessageTraceV2 and Get-MessageTraceDetailV2 cmdlets). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -47,7 +47,10 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 e5f7af804e..ecc0d0aa97 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Get-MigrationBatch.md @@ -20,29 +20,51 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX -### BatchesFromEndpoint +### Identity ``` -Get-MigrationBatch [-Endpoint ] +Get-MigrationBatch [[-Identity] ] [-Diagnostic] [-DiagnosticArgument ] [-DiagnosticInfo ] [-DomainController ] [-IncludeReport] [-Partition ] - [-Status ] + [-ResultSize ] + [-Status ] [] ``` -### Identity +### BatchesFromEndpoint ``` -Get-MigrationBatch [[-Identity] ] +Get-MigrationBatch [-Diagnostic] [-DiagnosticArgument ] - [-DiagnosticInfo ] [-DomainController ] + [-Endpoint ] + [-IncludeReport] + [-Status ] + [] +``` + +### BatchesByEndpoint +``` +Get-MigrationBatch + [-DiagnosticInfo ] + [-Endpoint ] [-IncludeReport] [-Partition ] - [-Status ] + [-ResultSize ] + [] +``` + +### BatchesByStatus +``` +Get-MigrationBatch + [-DiagnosticInfo ] + [-IncludeReport] + [-Partition ] + [-ResultSize ] + [-Status ] [] ``` @@ -104,7 +126,7 @@ Typically, you use this switch only at the request of Microsoft Customer Service ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Identity, BatchesFromEndpoint Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -122,25 +144,7 @@ The DiagnosticArgument parameter modifies the results that are returned by using ```yaml Type: String -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 -``` - -### -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) +Parameter Sets: Identity, BatchesFromEndpoint Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -178,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 @@ -189,6 +193,24 @@ 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: Identity, BatchesFromEndpoint +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 +``` + ### -Endpoint The Endpoint parameter returns a list of migration batches associated with the specified migration endpoint. @@ -196,7 +218,7 @@ If you use this parameter, you can't include the Identity parameter. ```yaml Type: MigrationEndpointIdParameter -Parameter Sets: BatchesFromEndpoint +Parameter Sets: BatchesFromEndpoint, BatchesByEndpoint Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -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 e324c6af05..1d8997faf8 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationConfig.md +++ b/exchange/exchange-ps/exchange/Get-MigrationConfig.md @@ -20,9 +20,23 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### Default ``` Get-MigrationConfig [-DomainController ] - [-Partition ] + [] +``` + +### Partition +``` +Get-MigrationConfig [-Partition ] + [-IncludeSimplifiedGmailMigrationData] + [] +``` + +### AllPartitions +``` +Get-MigrationConfig [-AllPartitions] + [-IncludeSimplifiedGmailMigrationData] [] ``` @@ -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-MigrationUser.md b/exchange/exchange-ps/exchange/Get-MigrationUser.md index a4f5ea6494..e379851050 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationUser.md +++ b/exchange/exchange-ps/exchange/Get-MigrationUser.md @@ -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,6 +54,7 @@ Get-MigrationUser [[-Identity] ] ``` Get-MigrationUser -EmailAddress [-DomainController ] + [-IncludeAssociatedUsers] [-ResultSize ] [-Partition ] [] @@ -175,6 +177,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeAssociatedUsers +This parameter is available only in the cloud-based service. + +{{ Fill IncludeAssociatedUsers 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 +``` + ### -Partition This parameter is available only in the cloud-based service. diff --git a/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md b/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md index 0583da9ec3..5e64b3de72 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md @@ -26,9 +26,10 @@ Get-MigrationUserStatistics [-Identity] [-DiagnosticArgument ] [-DiagnosticInfo ] [-DomainController ] + [-IncludeCopilotReport] [-IncludeReport] - [-LimitSkippedItemsTo ] [-IncludeSkippedItems] + [-LimitSkippedItemsTo ] [-Partition ] [-SkipSubscription] [] @@ -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-MobileDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md index de9463c4cf..d493f60367 100644 --- a/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md @@ -33,6 +33,7 @@ Get-MobileDeviceStatistics [-Identity] [-ShowRecoveryPassword] [-RestApi] [-UniversalOutlook] + [-UseCustomRouting] [] ``` @@ -47,6 +48,7 @@ Get-MobileDeviceStatistics -Mailbox [-ShowRecoveryPassword] [-RestApi] [-UniversalOutlook] + [-UseCustomRouting] [] ``` @@ -67,6 +69,7 @@ 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} ``` @@ -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-MoveRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md index a1fc294b2b..8f312cf0ae 100644 --- a/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md @@ -105,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 @@ -160,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. diff --git a/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md index f0077e402e..ad5461513b 100644 --- a/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md @@ -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://learn.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-Notification.md b/exchange/exchange-ps/exchange/Get-Notification.md index 5179cf6461..a354e891db 100644 --- a/exchange/exchange-ps/exchange/Get-Notification.md +++ b/exchange/exchange-ps/exchange/Get-Notification.md @@ -14,7 +14,16 @@ 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. + +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). @@ -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 a481fc2229..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://learn.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://learn.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://learn.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://learn.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 3a52d11faf..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://learn.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://learn.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://learn.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://learn.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 7305a552fe..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://learn.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://learn.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://learn.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://learn.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 996c7ca788..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://learn.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://learn.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://learn.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://learn.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 5d4e346fe6..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://learn.microsoft.com/powershell/module/exchange/get-omeconfiguration -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-OMEConfiguration schema: 2.0.0 author: chrisda @@ -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-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md index fe99263e92..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://learn.microsoft.com/powershell/module/exchange/get-onpremisesorganization -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-OnPremisesOrganization schema: 2.0.0 author: chrisda @@ -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-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md index 7be09516d7..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://learn.microsoft.com/powershell/module/exchange/get-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -58,7 +58,7 @@ The Identity parameter specifies the identity of the organizational relationship 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 diff --git a/exchange/exchange-ps/exchange/Get-OrganizationSegment.md b/exchange/exchange-ps/exchange/Get-OrganizationSegment.md index bdde96c5dd..12687a5a45 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationSegment.md +++ b/exchange/exchange-ps/exchange/Get-OrganizationSegment.md @@ -32,9 +32,9 @@ Get-OrganizationSegment [[-Identity] ] ``` ## DESCRIPTION -Segments are defined by using certain [attributes](https://learn.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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.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://learn.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) [New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-OutboundConnector.md b/exchange/exchange-ps/exchange/Get-OutboundConnector.md index 6db034fcdb..ef832c3069 100644 --- a/exchange/exchange-ps/exchange/Get-OutboundConnector.md +++ b/exchange/exchange-ps/exchange/Get-OutboundConnector.md @@ -24,6 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Get-OutboundConnector [[-Identity] ] [-IncludeTestModeConnectors ] [-IsTransportRuleScoped ] + [-ResultSize ] [] ``` @@ -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-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-PhishFilterPolicy.md b/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md deleted file mode 100644 index 565121c3d8..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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-spoofing-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://learn.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://learn.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 c8a3f8faeb..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://learn.microsoft.com/powershell/module/exchange/get-phishsimoverridepolicy -applicable: Exchange Online, Security & Compliance +applicable: Exchange Online title: Get-PhishSimOverridePolicy schema: 2.0.0 author: chrisda @@ -12,9 +12,9 @@ ms.reviewer: # Get-PhishSimOverridePolicy ## SYNOPSIS -This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 5197719d96..c13137555b 100644 --- a/exchange/exchange-ps/exchange/Get-Place.md +++ b/exchange/exchange-ps/exchange/Get-Place.md @@ -20,8 +20,18 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### Identity ``` -Get-Place [-Identity] +Get-Place [[-Identity] ] + [-Confirm] + [-ResultSize ] + [-WhatIf] + [] +``` + +### AllPlaces +``` +Get-Place [-Type ] [-Confirm] [-ResultSize ] [-WhatIf] @@ -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 43ddfa062a..7b985e28c4 100644 --- a/exchange/exchange-ps/exchange/Get-PolicyConfig.md +++ b/exchange/exchange-ps/exchange/Get-PolicyConfig.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-ProtectionAlert.md b/exchange/exchange-ps/exchange/Get-ProtectionAlert.md index 8292308818..2e99bc420c 100644 --- a/exchange/exchange-ps/exchange/Get-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Get-ProtectionAlert.md @@ -22,11 +22,12 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 ``` +### -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-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md index e05ca48bef..cbf1b56f79 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-PublicFolderClientPermission [-Identity] [-DomainController ] + [-ResultSize ] [-Server ] [-User ] [-Mailbox ] @@ -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-PublicFolderItemStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md index 7face7a0d8..7e8d13e1d4 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-PublicFolderItemStatistics [-Identity] [-DomainController ] + [-ResultSize ] [-Server ] [-Mailbox ] [] @@ -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-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md index 951f4a3a9a..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://learn.microsoft.com/powershell/module/exchange/get-publicfoldermoverequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PublicFolderMoveRequest schema: 2.0.0 author: chrisda @@ -12,7 +12,7 @@ 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. @@ -20,23 +20,22 @@ For information about the parameter sets in the Syntax section below, see [Excha ## 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 ] [] ``` @@ -80,7 +79,7 @@ You can't use this parameter with the following parameters: 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: False Position: 1 @@ -89,6 +88,24 @@ 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. @@ -98,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 @@ -108,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 @@ -135,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 @@ -153,7 +172,25 @@ 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 +Default value: None +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: 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 223de62226..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://learn.microsoft.com/powershell/module/exchange/get-publicfoldermoverequeststatistics -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PublicFolderMoveRequestStatistics schema: 2.0.0 author: chrisda @@ -12,7 +12,7 @@ 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. @@ -25,20 +25,23 @@ 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] [] ``` @@ -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-QuarantineMessage.md b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md index 41adab87a0..7e98a8ee18 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md @@ -23,17 +23,22 @@ For information about the parameter sets in the Syntax section below, see [Excha ### 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,10 +51,11 @@ Get-QuarantineMessage [-Direction ] [-ReleaseStatus ] [-Reported ] [-SenderAddress ] - [-StartExpiresDate ] - [-StartReceivedDate ] + [-StartExpiresDate ] + [-StartReceivedDate ] [-Subject ] - [-Type ] + [-TeamsConversationTypes ] + [-Type ] [] ``` @@ -60,10 +66,10 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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,7 +389,7 @@ Accept wildcard characters: False ``` ### -RecipientTag -The RecipientTag parameter filters the results by the recipient's user tag value (for example, `Priority Account`). For more information about user tags, see [User tags in Defender for Office 365](https://learn.microsoft.com/microsoft-365/security/office-365-security/user-tags-about). +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. @@ -346,7 +397,7 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -360,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 @@ -417,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 @@ -437,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 @@ -470,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) @@ -485,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 d2efc41bcb..9dac21f945 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-QuarantineMessageHeader -Identity + [-EntityType ] [-RecipientAddress ] [] ``` @@ -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 ea268deca8..93177a8f2a 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md @@ -22,12 +22,12 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-RMSTemplate.md b/exchange/exchange-ps/exchange/Get-RMSTemplate.md index 8013f23027..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://learn.microsoft.com/powershell/module/exchange/get-rmstemplate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -59,7 +59,7 @@ The Identity parameter specifies the name of the RMS template. Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 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 @@ -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-Recipient.md b/exchange/exchange-ps/exchange/Get-Recipient.md index 9687412486..4b5a71f8b1 100644 --- a/exchange/exchange-ps/exchange/Get-Recipient.md +++ b/exchange/exchange-ps/exchange/Get-Recipient.md @@ -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 ] @@ -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. diff --git a/exchange/exchange-ps/exchange/Get-RecipientPermission.md b/exchange/exchange-ps/exchange/Get-RecipientPermission.md index 05c1ffdaee..985fc7ff66 100644 --- a/exchange/exchange-ps/exchange/Get-RecipientPermission.md +++ b/exchange/exchange-ps/exchange/Get-RecipientPermission.md @@ -34,6 +34,9 @@ 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. +> [!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-RecordReviewNotificationTemplateConfig.md b/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md index 149d669a85..4f413a8bf3 100644 --- a/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md +++ b/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 d7edc9054c..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://learn.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 @@ -44,7 +44,9 @@ Get-RecoverableItems -Identity [-FilterStartTime ] [-LastParentFolderID ] [-MaxParallelSize ] + [-PolicyTag ] [-ResultSize ] + [-SkipCount ] [-SourceFolder ] [-SubjectContains ] [] @@ -134,7 +136,7 @@ Accept wildcard characters: False ### -FilterEndTime The FilterEndTime specifies the end date/time of the date range. This parameter uses the LastModifiedTime value of the item. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -174,7 +176,7 @@ Accept wildcard characters: False ### -FilterStartTime The FilterStartTime specifies the start date/time of the date range. This parameter uses the LastModifiedTime value of the item. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -225,6 +227,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyTag +This parameter is available only in the cloud-based service. + +{{ Fill PolicyTag Description }} + +```yaml +Type: String[] +Parameter Sets: Cloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResultSize The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -241,6 +261,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SkipCount +This parameter is available only in the cloud-based service. + +{{ Fill SkipCount Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SourceFolder The SourceFolder parameter specifies where to search for deleted items in the mailbox. Valid values are: @@ -248,9 +286,9 @@ The SourceFolder parameter specifies where to search for deleted items in the ma - RecoverableItems: The Recoverable Items\Deletions folder. This folder contains items that have been deleted from the Deleted Items folder (soft-deleted items). - PurgedItems: The Recoverable Items\Purges folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items). - If you don't use this parameter, the command will search these three folders. +If you don't use this parameter, the command searches those three folders. -- 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. To search for deleted items in this folder, use this parameter with the value DiscoveryHoldsItems. +- 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 4b26a1e0e0..69ceb96099 100644 --- a/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md +++ b/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 374f57cf3d..ea01811a75 100644 --- a/exchange/exchange-ps/exchange/Get-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/Get-RemoteDomain.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-RemoteDomain [[-Identity] ] [-DomainController ] + [-ResultSize ] [] ``` @@ -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 4214b553dc..f40415ec08 100644 --- a/exchange/exchange-ps/exchange/Get-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Get-RemoteMailbox.md @@ -49,7 +49,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 ``` diff --git a/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md index 1720ca5f30..483f073460 100644 --- a/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md @@ -25,7 +25,7 @@ Get-ReportSubmissionPolicy [[-Identity] ] [. +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. diff --git a/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md index afd80d7f3e..f64f8d899b 100644 --- a/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md +++ b/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md @@ -9,7 +9,6 @@ ms.author: chrisda ms.reviewer: --- - # Get-ReportSubmissionRule ## SYNOPSIS diff --git a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md index b3cebf6686..fbb20052f5 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md @@ -23,7 +23,10 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 3f69fac57b..9c1279ce96 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 47eb4d6bd6..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://learn.microsoft.com/powershell/module/exchange/get-retentionevent -applicable: Exchange Online +applicable: Exchange Online, Security & Compliance title: Get-RetentionEvent schema: 2.0.0 author: chrisda @@ -12,7 +12,7 @@ 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. @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-RetentionEvent [[-Identity] ] [-AllStatus] + [-DomainController ] [] ``` @@ -54,7 +55,7 @@ The Identity parameter specifies the retention event that you want to view. Type: EwsStoreObjectIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -79,6 +80,22 @@ 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 +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-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 1b7ccd7532..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://learn.microsoft.com/powershell/module/exchange/get-roleassignmentpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -69,7 +69,7 @@ The Identity parameter specifies the name of the assignment policy to view. If 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: False Position: 1 diff --git a/exchange/exchange-ps/exchange/Get-SPOActiveUserReport.md b/exchange/exchange-ps/exchange/Get-SPOActiveUserReport.md deleted file mode 100644 index 569c03715f..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://learn.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://learn.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://learn.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://learn.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 f1a25d984d..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://learn.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://learn.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://learn.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://learn.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 9fdee26efb..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://learn.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://learn.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://learn.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://learn.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 15b53a0a7c..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://learn.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://learn.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://learn.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://learn.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 631bc3d259..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://learn.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://learn.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://learn.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://learn.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 bd3567a059..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://learn.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://learn.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://learn.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://learn.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 66ffbd3dc0..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://learn.microsoft.com/powershell/module/exchange/get-safeattachmentpolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-SafeAttachmentPolicy schema: 2.0.0 author: chrisda @@ -26,7 +26,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-attachments-about). +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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 f4c9057bab..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://learn.microsoft.com/powershell/module/exchange/get-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -27,7 +27,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-attachments-about). +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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 ed4c1b7afd..27c72f641a 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md @@ -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 43b373a579..ef6379a4e6 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md @@ -21,7 +21,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Get-SafeLinksDetailReport [-Action ] +Get-SafeLinksDetailReport [-Action ] [-AppNameList ] [-Domain ] @@ -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 241b3a5c84..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://learn.microsoft.com/powershell/module/exchange/get-safelinkspolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-SafeLinksPolicy schema: 2.0.0 author: chrisda @@ -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 7138eb414b..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://learn.microsoft.com/powershell/module/exchange/get-safelinksrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Get-SafeLinksRule schema: 2.0.0 author: chrisda @@ -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-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md index 39419b3942..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://learn.microsoft.com/powershell/module/exchange/get-secopsoverridepolicy -applicable: Exchange Online, Security & Compliance +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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +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://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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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-ServicePrincipal.md b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md index 0126cd8158..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://learn.microsoft.com/powershell/module/exchange/get-serviceprincipal -applicable: Exchange Online +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-ServicePrincipal schema: 2.0.0 author: chrisda @@ -27,9 +27,9 @@ Get-ServicePrincipal [[-Identity] ] ``` ## 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -40,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 @@ -58,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 @@ -80,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-LicenseVsUsageSummaryReport.md b/exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md similarity index 51% rename from exchange/exchange-ps/exchange/Get-LicenseVsUsageSummaryReport.md rename to exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md index 420583cf95..2bc72a8f55 100644 --- a/exchange/exchange-ps/exchange/Get-LicenseVsUsageSummaryReport.md +++ b/exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md @@ -1,40 +1,31 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-licensevsusagesummaryreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-smtpdaneinboundstatus applicable: Exchange Online -title: Get-LicenseVsUsageSummaryReport +title: Get-SmtpDaneInboundStatus schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: --- -# Get-LicenseVsUsageSummaryReport +# Get-SmtpDaneInboundStatus ## 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://learn.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). +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-LicenseVsUsageSummaryReport [] +Get-SmtpDaneInboundStatus [-DomainName] [] ``` ## 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. +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). @@ -42,13 +33,29 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Get-LicenseVsUsageSummaryReport +Get-SmtpDaneInboundStatus -DomainName contoso.com ``` -This example gets a report of the active workload users. +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). diff --git a/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md b/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md index 4d7221ab26..01335195b4 100644 --- a/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md +++ b/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -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 f0fd53356c..312ec706dc 100644 --- a/exchange/exchange-ps/exchange/Get-SpoofMailReport.md +++ b/exchange/exchange-ps/exchange/Get-SpoofMailReport.md @@ -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 05ae30f380..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://learn.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://learn.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://learn.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://learn.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 1659a0ddc3..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://learn.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://learn.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://learn.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://learn.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-SupervisoryReviewActivity.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md index a1a0fe0ea4..420045a251 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md @@ -32,8 +32,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 901629e617..3a432c1505 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 f6560ceca6..d3982ce31b 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 c5af059962..cc356b57a5 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 2b810965b3..5e1a033aa5 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 f384f98d4a..1a7f812f23 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md @@ -22,12 +22,13 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 8fb8fc740d..f630b5e84b 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 e81e17f8aa..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://learn.microsoft.com/powershell/module/exchange/get-sweeprule -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-SweepRule schema: 2.0.0 author: chrisda @@ -26,6 +26,7 @@ Get-SweepRule [[-Identity] ] [-DomainController ] [-Mailbox ] [-Provider ] + [-ResultSize ] [] ``` @@ -68,7 +69,7 @@ The Identity parameter specifies the Sweep rule that you want to view. You can u Type: SweepRuleIdParameter 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: 1 @@ -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-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 c101232d25..f2a8862ef7 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +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. @@ -129,15 +131,13 @@ Accept wildcard characters: False ``` ### -Allow -This parameter is available only in Exchange Online PowerShell. - The Allow switch filters the results for allow entries. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -184,8 +184,6 @@ Accept wildcard characters: False ``` ### -ListSubType -This parameter is available only in Exchange Online PowerShell. - The ListSubType parameter filters the results by subtype. Valid values are: - AdvancedDelivery @@ -195,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 3fc1b1b2b6..a77fd3036a 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md @@ -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 21a8243efa..11e102c7e7 100644 --- a/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md +++ b/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md @@ -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} ``` diff --git a/exchange/exchange-ps/exchange/Get-TransportRule.md b/exchange/exchange-ps/exchange/Get-TransportRule.md index 63f1d47511..d55f8756f4 100644 --- a/exchange/exchange-ps/exchange/Get-TransportRule.md +++ b/exchange/exchange-ps/exchange/Get-TransportRule.md @@ -59,14 +59,14 @@ For more information about pipelining, see [About Pipelines](https://learn.micro 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 @@ -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. diff --git a/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md b/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md index e295ce0584..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://learn.microsoft.com/powershell/module/exchange/get-umcallsummaryreport -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Get-UMCallSummaryReport schema: 2.0.0 author: chrisda @@ -12,7 +12,7 @@ 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. @@ -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,12 +39,12 @@ 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. @@ -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-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md index 66c942ed7d..07a961fcf8 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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://learn.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"`. diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md b/exchange/exchange-ps/exchange/Get-UnifiedGroup.md index aaa0cf6ff1..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://learn.microsoft.com/powershell/module/exchange/get-unifiedgroup -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-UnifiedGroup schema: 2.0.0 author: chrisda @@ -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 ] @@ -108,7 +118,7 @@ The Identity parameter specifies the Microsoft 365 Group that you want to view. Type: UnifiedGroupIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -124,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 @@ -149,7 +159,25 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH 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 +``` + +### -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. + +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, Exchange Online Protection Required: False Position: Named @@ -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 e2510b3047..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://learn.microsoft.com/powershell/module/exchange/get-unifiedgrouplinks -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Get-UnifiedGroupLinks schema: 2.0.0 author: chrisda @@ -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 @@ -76,7 +76,7 @@ The LinkType parameter filters the results by recipient roles in the Microsoft 3 Type: LinkType Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -92,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 352d182018..3cafe8aba0 100644 --- a/exchange/exchange-ps/exchange/Get-User.md +++ b/exchange/exchange-ps/exchange/Get-User.md @@ -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] @@ -295,6 +297,24 @@ 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. @@ -398,7 +418,7 @@ The RecipientTypeDetails parameter filters the results by the specified user sub - RoomMailbox - SchedulingMailbox (Exchange 2016 or later and cloud) - SharedMailbox -- ShareWithMailUser (cloud only) +- 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 edc4879d7d..6c04f88148 100644 --- a/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md @@ -26,13 +26,18 @@ Get-UserBriefingConfig -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://learn.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/Get-UserPhoto.md b/exchange/exchange-ps/exchange/Get-UserPhoto.md index 149243fb82..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://learn.microsoft.com/powershell/module/exchange/get-userphoto -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-UserPhoto schema: 2.0.0 author: chrisda @@ -12,9 +12,11 @@ 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. + +**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). @@ -57,8 +59,6 @@ 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://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguserphoto) and [Get-MgUserPhotoContent](https://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -97,7 +97,7 @@ The Identity parameter specifies the user account. You can use any value that un Type: MailboxIdParameter Parameter Sets: Identity 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 @@ -119,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 @@ -137,7 +137,7 @@ A value for this parameter requires the Get-Credential cmdlet. To pause this com 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 @@ -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 @@ -180,7 +178,7 @@ For detailed information about OPATH filters in Exchange, see [Additional OPATH 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 @@ -196,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 @@ -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-VivaInsightsSettings.md b/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md index 7208720851..bbfd395ab1 100644 --- a/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md +++ b/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md @@ -30,13 +30,18 @@ Get-VivaInsightsSettings -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 - Teams Administrator -To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://learn.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/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-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md index 4898514c77..2af5f1721a 100644 --- a/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 3d56910dcc..bdec677fd8 100644 --- a/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md +++ b/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md @@ -12,9 +12,11 @@ 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. + +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). @@ -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 86d5e52409..41752441f8 100644 --- a/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md b/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md index ec6da6bc62..3c8ed062fd 100644 --- a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md +++ b/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md @@ -14,6 +14,8 @@ ms.reviewer: ## SYNOPSIS Use the Import-RecipientDataProperty cmdlet to add a picture or a spoken name audio file to a mailbox or mail contact. +**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,8 +41,6 @@ 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://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 76782775ae..30fae12016 100644 --- a/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md +++ b/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md @@ -12,10 +12,12 @@ 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. +**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 diff --git a/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md b/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md index 36df5dd463..dfc3b902a4 100644 --- a/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md +++ b/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md @@ -14,7 +14,7 @@ ms.reviewer: ## 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 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. @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-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/Move-AddressList.md b/exchange/exchange-ps/exchange/Move-AddressList.md index bfa1fff122..d2c70381c6 100644 --- a/exchange/exchange-ps/exchange/Move-AddressList.md +++ b/exchange/exchange-ps/exchange/Move-AddressList.md @@ -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/Move-DatabasePath.md b/exchange/exchange-ps/exchange/Move-DatabasePath.md index 035b0ad6ef..88ab1bea84 100644 --- a/exchange/exchange-ps/exchange/Move-DatabasePath.md +++ b/exchange/exchange-ps/exchange/Move-DatabasePath.md @@ -97,6 +97,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/Move-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Move-OfflineAddressBook.md index d2fa6fd4d2..52e6b27ad3 100644 --- a/exchange/exchange-ps/exchange/Move-OfflineAddressBook.md +++ b/exchange/exchange-ps/exchange/Move-OfflineAddressBook.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Move-OfflineAddressBook cmdlet to designate a new server responsible for generating the offline address book (OAB) in Exchange Server 2010. This cmdlet isn't used on OABs in Exchange Server 2016 or Exchange Server 2013. To perform this task in Exchange 2016 or Exchange 2013, use the Set-OfflineAddressBook cmdlet with the GeneratingMailbox parameter. +Use the Move-OfflineAddressBook cmdlet to designate a new server that's responsible for generating the offline address book (OAB) in Exchange Server 2010. This cmdlet isn't used on OABs in Exchange Server 2016 or Exchange Server 2013. To perform this task in Exchange 2016 or Exchange 2013, use the Set-OfflineAddressBook cmdlet with the GeneratingMailbox parameter. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -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 dab9f05bc8..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://learn.microsoft.com/powershell/module/exchange/new-atpbuiltinprotectionrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: New-ATPBuiltInProtectionRule schema: 2.0.0 author: chrisda @@ -35,10 +35,10 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 30db027373..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://learn.microsoft.com/powershell/module/exchange/new-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: New-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -39,10 +39,10 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-ActivityAlert.md b/exchange/exchange-ps/exchange/New-ActivityAlert.md deleted file mode 100644 index f91e6ad00d..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://learn.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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.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://learn.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://learn.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://learn.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 78f5e83988..88433a9deb 100644 --- a/exchange/exchange-ps/exchange/New-AdaptiveScope.md +++ b/exchange/exchange-ps/exchange/New-AdaptiveScope.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ### Default ``` New-AdaptiveScope -Name -FilterConditions -LocationType + [-AdministrativeUnit ] [-Comment ] [] ``` @@ -30,14 +31,15 @@ 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://learn.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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -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 49ba5c6b4a..4bade089b4 100644 --- a/exchange/exchange-ps/exchange/New-AddressBookPolicy.md +++ b/exchange/exchange-ps/exchange/New-AddressBookPolicy.md @@ -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 bcf34b88b1..540855b553 100644 --- a/exchange/exchange-ps/exchange/New-AddressList.md +++ b/exchange/exchange-ps/exchange/New-AddressList.md @@ -79,7 +79,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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. diff --git a/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md b/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md index f73a020742..1059619e55 100644 --- a/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md +++ b/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md @@ -12,6 +12,9 @@ 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. @@ -65,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 @@ -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-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md index 6475e2a404..412a2a5340 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md @@ -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 ] @@ -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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-spoofing-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://learn.microsoft.com/microsoft-365/security/office-365-security/email-authentication-about#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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-spoofing-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://learn.microsoft.com/microsoft-365/security/office-365-security/email-authentication-about#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,7 +495,7 @@ 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. @@ -468,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. @@ -487,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: @@ -510,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. @@ -537,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. @@ -557,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: @@ -565,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 @@ -599,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: @@ -638,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://learn.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 @@ -676,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 @@ -692,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. @@ -712,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 @@ -737,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: @@ -745,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 @@ -761,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. @@ -781,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. @@ -801,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 @@ -826,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: @@ -834,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 @@ -850,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. @@ -858,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 14b2468d0e..79afcd0346 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishRule.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishRule.md @@ -40,7 +40,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-phishing-policies-about#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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 213ebee0d8..12f88e9b57 100644 --- a/exchange/exchange-ps/exchange/New-App.md +++ b/exchange/exchange-ps/exchange/New-App.md @@ -22,23 +22,25 @@ For information about the parameter sets in the Syntax section below, see [Excha ### 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] [] ``` @@ -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. @@ -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 7d235c21ef..669e94235e 100644 --- a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md @@ -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://learn.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 5d5d724417..9cf40c975c 100644 --- a/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -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://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/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-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md index e8a1d4bc9d..3a8139e536 100644 --- a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md @@ -14,14 +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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). -**Note:** App Access Policies will soon be replaced by Roles Based Access Control for Applications. To learn more, see [Roles Based Access Control for Exchange Applications](https://learn.microsoft.com/exchange/permissions-exo/application-rbac). - ## SYNTAX - ``` New-ApplicationAccessPolicy -AccessRight -AppId -PolicyScopeGroupId [-Confirm] @@ -35,7 +35,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi You can create a limited number of policies in your organization based on a fixed amount of space. If your organization runs out of space for these policies, you'll see the error: "The total size of App Access Policies exceeded the limit." To maximize the number of policies and reduce the amount of space that's consumed by the policies, set a one space character description for the policy. This method will allow approximately 300 policies (versus a previous limit of 100 policies). -While scope-based resource access like Mail.Read or Calendar.Read is effective to ensure that the application can only read email or events within a mailbox and not do anything else, application access policies allow admins to enforce limits that are based on a list of mailboxes. For example, apps developed for one country shouldn't have access to data from other countries. Or, or a CRM integration application should only access calendars in the Sales organization and no other departments. +While scope-based resource access like Mail.Read or Calendar.Read is effective to ensure that the application can only read email or events within a mailbox and not do anything else, application access policies allow admins to enforce limits that are based on a list of mailboxes. For example, apps developed for one country/region shouldn't have access to data from other countries/regions. Or, or a CRM integration application should only access calendars in the Sales organization and no other departments. Every API request using the Outlook REST APIs or Microsoft Graph APIs to a target mailbox done by an application is verified using the following rules (in the same order): @@ -123,7 +123,7 @@ Accept wildcard characters: False ``` ### -PolicyScopeGroupID -The PolicyScopeGroupID parameter specifies the recipient to define in the policy. Valid recipient types are security principals in Exchange Online (users or groups that can have permissions assigned to them). 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) @@ -201,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 8f6cec50e5..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://learn.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://learn.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://learn.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://learn.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 a11e88765f..d885bf6957 100644 --- a/exchange/exchange-ps/exchange/New-AuthRedirect.md +++ b/exchange/exchange-ps/exchange/New-AuthRedirect.md @@ -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 937034caeb..5837e8cdb9 100644 --- a/exchange/exchange-ps/exchange/New-AuthServer.md +++ b/exchange/exchange-ps/exchange/New-AuthServer.md @@ -47,6 +47,7 @@ New-AuthServer [-Name] -AuthMetadataUrl -Type ### AppSecret ``` New-AuthServer [-Name] -Type + [-ApplicationIdentifier ] [-Confirm] [-DomainController ] [-DomainName ] @@ -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 ef2b4c7a50..4c06f72d1a 100644 --- a/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md +++ b/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md @@ -42,6 +42,14 @@ New-AuthenticationPolicy [[-Name] ] [-BlockLegacyAuthPop] [-BlockLegacyAuthRpc] [-BlockLegacyAuthWebServices] + [-BlockModernAuthActiveSync] + [-BlockModernAuthAutodiscover] + [-BlockModernAuthImap] + [-BlockModernAuthMapi] + [-BlockModernAuthOfflineAddressBook] + [-BlockModernAuthPop] + [-BlockModernAuthRpc] + [-BlockModernAuthWebServices] [-Confirm] [-WhatIf] [] @@ -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 f7e7d7e56e..41c5654713 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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,12 +35,20 @@ New-AutoSensitivityLabelPolicy [-Name] -ApplySensitivityLabel [-ExchangeSenderMemberOfException ] [-ExternalMailRightsManagementOwner ] [-Force] + [-Locations ] [-Mode ] + [-OneDriveAdaptiveScopes ] + [-OneDriveAdaptiveScopesException ] [-OneDriveLocation ] [-OneDriveLocationException ] + [-OneDriveSharedBy ] + [-OneDriveSharedByMemberOf ] [-OverwriteLabel ] + [-PolicyRBACScopes ] [-PolicyTemplateInfo ] [-Priority ] + [-SharePointAdaptiveScopes ] + [-SharePointAdaptiveScopesException ] [-SharePointLocation ] [-SharePointLocationException ] [-UnifiedAuditLogEnabled ] @@ -45,7 +57,7 @@ New-AutoSensitivityLabelPolicy [-Name] -ApplySensitivityLabel ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 +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 @@ -125,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). @@ -283,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: @@ -305,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"`. @@ -324,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"`. @@ -341,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: @@ -362,6 +530,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 +``` + ### -PolicyTemplateInfo This parameter is reserved for internal Microsoft use. @@ -394,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 @@ -413,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"`. diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md index dea3897c28..43a5384ec8 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-AvailabilityConfig.md b/exchange/exchange-ps/exchange/New-AvailabilityConfig.md index 011b331b95..7019d149b7 100644 --- a/exchange/exchange-ps/exchange/New-AvailabilityConfig.md +++ b/exchange/exchange-ps/exchange/New-AvailabilityConfig.md @@ -14,15 +14,17 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -New-AvailabilityConfig -OrgWideAccount +New-AvailabilityConfig + [-AllowedTenantIds ] [-Confirm] + [-OrgWideAccount ] [-WhatIf] [] ``` @@ -34,40 +36,23 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md index 7d90aaed36..87605314fc 100644 --- a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md @@ -16,7 +16,10 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 +48,7 @@ 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. @@ -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://learn.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 51ececa3f5..c169c5dfff 100644 --- a/exchange/exchange-ps/exchange/New-CaseHoldRule.md +++ b/exchange/exchange-ps/exchange/New-CaseHoldRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://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/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 8aef1e567b..2f589a0ceb 100644 --- a/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md @@ -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 f370a36495..93bc940c38 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessArray.md +++ b/exchange/exchange-ps/exchange/New-ClientAccessArray.md @@ -88,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) diff --git a/exchange/exchange-ps/exchange/New-ClientAccessRule.md b/exchange/exchange-ps/exchange/New-ClientAccessRule.md index ffd75f8258..af5e934438 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/New-ClientAccessRule.md @@ -12,6 +12,9 @@ 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. @@ -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) diff --git a/exchange/exchange-ps/exchange/New-ComplianceCase.md b/exchange/exchange-ps/exchange/New-ComplianceCase.md index 199632f0bf..6366bff3d0 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/New-ComplianceCase.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 2a166d961c..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://learn.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 @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.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 1718926ccc..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://learn.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 @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 ef1f4996ba..bb3b8def59 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSearch.md @@ -53,7 +53,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://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/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 @@ -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 3459845828..e2b6541d63 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md @@ -102,7 +102,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.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,6 +623,8 @@ 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 @@ -633,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. @@ -641,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. @@ -659,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 92950ef482..cf258e62c7 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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,7 +75,13 @@ This example prevents the user from performing any compliance search actions on ## PARAMETERS ### -Action -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. +The Action parameter specifies that type of search action that the filter is applied to. Valid values are: + +- Export: The filter is applied when exporting search results, or preparing them for analysis in 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 @@ -167,8 +173,8 @@ Accept wildcard characters: False 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://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/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://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. +- 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/New-ComplianceTag.md b/exchange/exchange-ps/exchange/New-ComplianceTag.md index 7cc64a0011..9de8c0fca4 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/New-ComplianceTag.md @@ -20,8 +20,10 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### Default ``` New-ComplianceTag [-Name] + [-AutoApprovalPeriod ] [-Comment ] [-ComplianceTagForNextStage ] [-Confirm] @@ -42,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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 +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". @@ -324,66 +469,6 @@ 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: (All) -Aliases: -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetentionDuration -The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: - -- A positive integer. -- The value unlimited. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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: (All) -Aliases: -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ReviewerEmail The ReviewerEmail parameter specifies the email address of a reviewer for Delete and KeepAndDelete retention actions. You can specify multiple email addresses separated by commas. diff --git a/exchange/exchange-ps/exchange/New-DataClassification.md b/exchange/exchange-ps/exchange/New-DataClassification.md index 9781ed45cd..ee21f6fc1a 100644 --- a/exchange/exchange-ps/exchange/New-DataClassification.md +++ b/exchange/exchange-ps/exchange/New-DataClassification.md @@ -42,9 +42,13 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell $Employee_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Employee Template.docx') + $Employee_Fingerprint = New-Fingerprint -FileData $Employee_Template -Description "Contoso Employee Template" + $Customer_Template = [System.IO.File]::ReadAllBytes('D:\Data\Contoso Customer Template.docx') + $Customer_Fingerprint = New-Fingerprint -FileData $Customer_Template -Description "Contoso Customer Template" + New-DataClassification -Name "Contoso Employee-Customer Confidential" -Fingerprints $Employee_Fingerprint,$Customer_Fingerprint -Description "Message contains Contoso employee or customer information." ``` diff --git a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md index ec40d184d5..b8386092bb 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md @@ -40,7 +40,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 a9feb5b169..102c007035 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md @@ -86,7 +86,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 b63a0060be..67e19df788 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md @@ -40,7 +40,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 eb5295f1b8..e4505ceb8f 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md @@ -85,7 +85,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 ea189906b5..13317afc2d 100644 --- a/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md @@ -39,7 +39,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 36d11fb643..214a1d7524 100644 --- a/exchange/exchange-ps/exchange/New-DeviceTenantRule.md +++ b/exchange/exchange-ps/exchange/New-DeviceTenantRule.md @@ -40,7 +40,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 d6919c87be..de47db246c 100644 --- a/exchange/exchange-ps/exchange/New-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/New-DistributionGroup.md @@ -61,6 +61,8 @@ Distribution groups are used to consolidate groups of recipients into a single p You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or 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 @@ -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,11 +300,11 @@ 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**: 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. +**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 @@ -341,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 @@ -428,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 d207ece8c4..5bd296a8ba 100644 --- a/exchange/exchange-ps/exchange/New-DkimSigningConfig.md +++ b/exchange/exchange-ps/exchange/New-DkimSigningConfig.md @@ -70,7 +70,7 @@ Accept wildcard characters: False ### -Enabled The Enabled parameter specifies whether the policy is enabled. Valid values are: -- $true: The policy is enabled. This is the default value. +- $true: The policy is enabled. - $false: The policy is disabled. ```yaml @@ -160,9 +160,12 @@ 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 (this is the default value) +- 2048 + +RSA keys are supported. Ed25519 keys aren't supported. ```yaml Type: UInt16 diff --git a/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md index d843d6408d..53dccb7f13 100644 --- a/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md @@ -24,37 +24,53 @@ For information about the parameter sets in the Syntax section below, see [Excha New-DlpCompliancePolicy [-Name] [-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.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://learn.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). @@ -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://learn.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://learn.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://learn.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://learn.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://learn.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 31fa54cef2..177d38fa19 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -22,37 +22,44 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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 ] @@ -69,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 ] @@ -95,46 +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 ] @@ -143,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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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,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 @@ -175,7 +198,7 @@ $contains_complex_types = @{ groups = @( @{ operator = "Or" - name = "PII Identifiers" + name = "PII Identifiers" sensitivetypes = @( @{ name = "Drug Enforcement Agency (DEA) Number" @@ -188,7 +211,7 @@ $contains_complex_types = @{ } @{ operator = "Or" - name = "Medical Terms" + name = "Medical Terms" sensitivetypes = @( @{ name = "International Classification of Diseases (ICD-9-CM)" @@ -213,7 +236,7 @@ $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 @@ -275,12 +298,31 @@ Contents of the file named C:\Data\Sensitive Type.txt: } } -$data = Get-Content -Path "C:\Data\Sensitive Type.txt" -ReadCount 0 -New-DLPComplianceRule -Name "Contoso Rule 1" -Policy "Contoso Policy 1" -AdvancedRule $data -NotifyUer +$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 ### -Name @@ -300,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) @@ -328,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 @@ -344,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 @@ -420,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. @@ -457,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 = }`. @@ -479,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: @@ -501,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 @@ -594,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. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. +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 @@ -625,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 @@ -699,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 @@ -715,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[] @@ -731,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. @@ -844,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 @@ -855,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 ("). @@ -874,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: @@ -897,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://learn.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[] @@ -912,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: @@ -920,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 @@ -939,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. @@ -1049,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 @@ -1103,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 @@ -1119,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[] @@ -1135,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. @@ -1248,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 @@ -1343,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 @@ -1436,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 @@ -1463,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 @@ -1499,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. @@ -1549,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. @@ -1595,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 @@ -1615,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. @@ -1665,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. @@ -1869,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. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. +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. @@ -1896,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 @@ -1912,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 @@ -2007,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 @@ -2132,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 @@ -2160,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 @@ -2168,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[] @@ -2183,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. @@ -2199,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 @@ -2238,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. @@ -2290,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 @@ -2306,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. @@ -2324,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. @@ -2343,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. @@ -2363,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://learn.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 @@ -2383,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. @@ -2400,7 +2707,7 @@ 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://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -2419,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: @@ -2480,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. @@ -2511,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 @@ -2568,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. @@ -2618,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. @@ -2663,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 @@ -2759,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: @@ -2767,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 @@ -2784,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. @@ -2834,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. @@ -2886,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 @@ -2926,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. @@ -3003,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: @@ -3104,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. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. +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. @@ -3122,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. @@ -3148,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 136c0394bf..27c440830a 100644 --- a/exchange/exchange-ps/exchange/New-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/New-DlpEdmSchema.md @@ -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://learn.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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 fb8c11042a..cbd457cd29 100644 --- a/exchange/exchange-ps/exchange/New-DlpFingerprint.md +++ b/exchange/exchange-ps/exchange/New-DlpFingerprint.md @@ -22,8 +22,9 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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" ``` @@ -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 839fd48a97..10ac021e60 100644 --- a/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 ee49a0f7ea..705a5e5e46 100644 --- a/exchange/exchange-ps/exchange/New-DlpPolicy.md +++ b/exchange/exchange-ps/exchange/New-DlpPolicy.md @@ -12,9 +12,11 @@ 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. + +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). @@ -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 5ea055dead..961c0d2e48 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md @@ -21,9 +21,14 @@ For information about the parameter sets in the Syntax section below, see [Excha ## 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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." ``` @@ -59,13 +68,29 @@ Parameter Sets: (All) Aliases: Applicable: Security & Compliance -Required: True +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://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Description The Description parameter specifies a description for the sensitive information type rule. @@ -75,26 +100,26 @@ Parameter Sets: (All) Aliases: Applicable: Security & Compliance -Required: True +Required: False Position: Named 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://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. +### -FileData +{{ Fill FileData Description }} ```yaml -Type: MultiValuedProperty +Type: Byte[] Parameter Sets: (All) Aliases: Applicable: Security & Compliance -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -117,6 +142,22 @@ 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. @@ -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 6e2b640efb..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://learn.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 @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.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 a9cb0bb79a..548bcc5965 100644 --- a/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md @@ -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". @@ -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. diff --git a/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md deleted file mode 100644 index 1ad5a862fa..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://learn.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://learn.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://learn.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 d629184ebd..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://learn.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://learn.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://learn.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 16e0251028..0f0e180485 100644 --- a/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -38,10 +38,10 @@ New-EOPProtectionPolicyRule [-Name] [-Priority ] -AntiPhishPolic ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-EdgeSubscription.md b/exchange/exchange-ps/exchange/New-EdgeSubscription.md index 18dff4bba0..e7c67b1d70 100644 --- a/exchange/exchange-ps/exchange/New-EdgeSubscription.md +++ b/exchange/exchange-ps/exchange/New-EdgeSubscription.md @@ -51,6 +51,7 @@ This example creates the Edge Subscription file. It should be run on your Edge T ### Example 2 ```powershell $Temp = [System.IO.File]::ReadAllBytes('C:\Data\EdgeSubscription.xml') + New-EdgeSubscription -FileData $Temp -Site "Default-First-Site-Name" ``` diff --git a/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md index 3b5c7e25df..966babe33d 100644 --- a/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -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: diff --git a/exchange/exchange-ps/exchange/New-ExchangeCertificate.md b/exchange/exchange-ps/exchange/New-ExchangeCertificate.md index fa1bb4c8b1..5d957d9ce7 100644 --- a/exchange/exchange-ps/exchange/New-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/New-ExchangeCertificate.md @@ -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-PhishSimOverrideRule.md b/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md similarity index 64% rename from exchange/exchange-ps/exchange/New-PhishSimOverrideRule.md rename to exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md index 4fa49d09fa..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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +Use the New-ExoPhishSimOverrideRule cmdlet to create third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### Default ``` -New-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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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-SecOpsOverrideRule.md b/exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md similarity index 53% rename from exchange/exchange-ps/exchange/New-SecOpsOverrideRule.md rename to exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md index 5380c33793..7abc967735 100644 --- a/exchange/exchange-ps/exchange/New-SecOpsOverrideRule.md +++ b/exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md @@ -1,64 +1,50 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/new-secopsoverriderule -applicable: Security & Compliance -title: New-SecOpsOverrideRule +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-SecOpsOverrideRule +# New-ExoSecOpsOverrideRule ## 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). +This cmdlet is available only in the cloud-based service. -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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +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-SecOpsOverrideRule [-Name] -Policy +New-ExoSecOpsOverrideRule -Policy [-Comment ] [-Confirm] - [-SentTo ] + [-DomainController ] + [-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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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-SecOpsOverrideRule -Name SecOpsOverrideRule -Policy SecOpsOverridePolicy +New-ExoSecOpsOverrideRule -Name SecOpsOverrideRule -Policy SecOpsOverridePolicy ``` -This example creates the SecOps mailbox override rule with the specified settings. +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 -### -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: @@ -71,7 +57,7 @@ The Policy parameter specifies the phishing simulation override policy that's as Type: PolicyIdParameter Parameter Sets: Default, PublishComplianceTag, ComplianceTag, SetRawXml Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: True Position: Named @@ -87,7 +73,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: Default Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -97,16 +83,13 @@ 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 Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -115,14 +98,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SentTo +### -DomainController This parameter is reserved for internal Microsoft use. ```yaml -Type: MultiValuedProperty +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: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -132,13 +131,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/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-Fingerprint.md b/exchange/exchange-ps/exchange/New-Fingerprint.md index b560891d73..b2d1f80558 100644 --- a/exchange/exchange-ps/exchange/New-Fingerprint.md +++ b/exchange/exchange-ps/exchange/New-Fingerprint.md @@ -39,6 +39,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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-GlobalAddressList.md b/exchange/exchange-ps/exchange/New-GlobalAddressList.md index 9b4c587504..990ae4ba24 100644 --- a/exchange/exchange-ps/exchange/New-GlobalAddressList.md +++ b/exchange/exchange-ps/exchange/New-GlobalAddressList.md @@ -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. diff --git a/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md index 5a6b4ced4b..68a8cdeb6a 100644 --- a/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 d497c5f861..9ebebdb7c5 100644 --- a/exchange/exchange-ps/exchange/New-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-HoldComplianceRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://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/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 2e90e64077..ef6356928d 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md @@ -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 ] @@ -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://learn.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://learn.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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- 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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-spam-bulk-complaint-level-bcl-about). +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://learn.microsoft.com/microsoft-365/security/office-365-security/https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). -- 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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). -- 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 e97805c69b..427202c583 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md @@ -38,7 +38,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-spam-policies-configure#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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 e1521c6a38..6f78d93176 100644 --- a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md @@ -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://learn.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://learn.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://learn.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://learn.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 @@ -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://learn.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-InboundConnector.md b/exchange/exchange-ps/exchange/New-InboundConnector.md index e0512cb344..ab3f7a8b2d 100644 --- a/exchange/exchange-ps/exchange/New-InboundConnector.md +++ b/exchange/exchange-ps/exchange/New-InboundConnector.md @@ -16,6 +16,8 @@ This cmdlet is available only in the cloud-based service. Use the New-InboundConnector cmdlet to create a new Inbound connector in your cloud-based organization. +**Note**: 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 @@ -23,6 +25,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` New-InboundConnector [-Name] -SenderDomains [-AssociatedAcceptedDomains ] + [-ClientHostNames ] [-CloudServicesMailEnabled ] [-Comment ] [-Confirm] @@ -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,6 +127,22 @@ 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://learn.microsoft.com/exchange/hybrid-configuration-wizard). @@ -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 34c444ecd9..a3b0fe0e83 100644 --- a/exchange/exchange-ps/exchange/New-InboxRule.md +++ b/exchange/exchange-ps/exchange/New-InboxRule.md @@ -122,7 +122,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 bbe713f293..0e1826be8c 100644 --- a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md @@ -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://learn.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://learn.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://learn.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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.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-label.md b/exchange/exchange-ps/exchange/New-Label.md similarity index 88% rename from exchange/exchange-ps/exchange/new-label.md rename to exchange/exchange-ps/exchange/New-Label.md index e4760733e7..ccfa3a9d5e 100644 --- a/exchange/exchange-ps/exchange/new-label.md +++ b/exchange/exchange-ps/exchange/New-Label.md @@ -37,6 +37,7 @@ New-Label [-Name] -DisplayName -Tooltip [-ApplyContentMarkingHeaderFontSize ] [-ApplyContentMarkingHeaderMargin ] [-ApplyContentMarkingHeaderText ] + [-ApplyDynamicWatermarkingEnabled ] [-ApplyWaterMarkingEnabled ] [-ApplyWaterMarkingFontColor ] [-ApplyWaterMarkingFontName ] @@ -49,6 +50,7 @@ New-Label [-Name] -DisplayName -Tooltip [-Confirm] [-ContentType ] [-DefaultContentLabel ] + [-DynamicWatermarkDisplay ] [-EncryptionAipTemplateScopes ] [-EncryptionContentExpiredOnDateInDaysOrNever ] [-EncryptionDoNotForward ] @@ -81,7 +83,11 @@ New-Label [-Name] -DisplayName -Tooltip [-SiteExternalSharingControlType ] [-TeamsAllowedPresenters ] [-TeamsAllowMeetingChat ] + [-TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch ] [-TeamsBypassLobbyForDialInUsers ] + [-TeamsChannelProtectionEnabled ] + [-TeamsChannelSharedWithExternalTenants ] + [-TeamsChannelSharedWithPrivateTeamsOnly ] [-TeamsChannelSharedWithSameLabelOnly ] [-TeamsCopyRestrictionEnforced ] [-TeamsEndToEndEncryptionEnabled ] @@ -97,7 +103,7 @@ New-Label [-Name] -DisplayName -Tooltip ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -163,25 +169,27 @@ The AdvancedSettings parameter enables specific features and capabilities for a Specify this parameter with the identity (name or GUID) of the sensitivity label, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. -Some of the settings that you configure with this parameter are supported only by the 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://learn.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: -- **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/microsoft-365/compliance/sensitivity-labels-office-apps#configuring-custom-colors-by-using-powershell). +- **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). -- **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/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: `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). -- **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/microsoft-365/compliance/sensitivity-labels-default-sharing-link). +- **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). -- **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/microsoft-365/compliance/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). -- **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/microsoft-365/compliance/sensitivity-labels-office-apps#specify-a-default-sublabel-for-a-parent-label). +- **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://learn.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](https://learn.microsoft.com/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). -- **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/microsoft-365/compliance/sensitivity-labels-office-apps#configure-a-label-to-apply-smime-protection-in-outlook). +- **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 @@ -298,7 +306,7 @@ 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, 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. +**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 @@ -431,7 +439,7 @@ 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, 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. +**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 @@ -464,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: @@ -538,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 @@ -646,13 +677,15 @@ Accept wildcard characters: False ### -ContentType 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 @@ -683,6 +716,29 @@ 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']"`. @@ -1303,6 +1359,22 @@ 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: @@ -1323,6 +1395,54 @@ 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 }} diff --git a/exchange/exchange-ps/exchange/New-LabelPolicy.md b/exchange/exchange-ps/exchange/New-LabelPolicy.md index 2624d11e85..ce59ac07c5 100644 --- a/exchange/exchange-ps/exchange/New-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/New-LabelPolicy.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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,19 +102,25 @@ The AdvancedSettings parameter enables client-specific features and capabilities 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. -Some 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://learn.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: -- **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"}`. +- **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://learn.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"}`. -- **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/microsoft-365/compliance/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). +- **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). -- **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/microsoft-365/compliance/sensitivity-labels-meetings). +- **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). -- **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/microsoft-365/compliance/sensitivity-labels-meetings). +- **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"}` @@ -321,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 857a6c6f34..1182270b7a 100644 --- a/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md @@ -31,7 +31,7 @@ New-M365DataAtRestEncryptionPolicy [-Name] -AzureKeyIDs -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,7 +210,10 @@ New-MailUser [-Name] [-ModeratedBy ] [-ModerationEnabled ] [-OrganizationalUnit ] + [-PrimarySmtpAddress ] [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-SamAccountName ] [-SendModerationNotifications ] [-WhatIf] [] @@ -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 00b659b129..8a4bb79a06 100644 --- a/exchange/exchange-ps/exchange/New-Mailbox.md +++ b/exchange/exchange-ps/exchange/New-Mailbox.md @@ -119,6 +119,7 @@ New-Mailbox [-Name] [-Arbitration] [-Password ] [-UserPri [-MailboxRegion ] [-OrganizationalUnit ] [-PrimarySmtpAddress ] + [-ProxyEmailAddress ] [-RemotePowerShellEnabled ] [-ResetPasswordOnNextLogon ] [-RetentionPolicy ] @@ -764,11 +765,14 @@ 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://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) @@ -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 @@ -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. @@ -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. @@ -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 e920ddc6c7..38f9329045 100644 --- a/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md +++ b/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md @@ -12,6 +12,9 @@ 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. @@ -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-MailboxExportRequest.md b/exchange/exchange-ps/exchange/New-MailboxExportRequest.md index c98154ab9b..56a97e1c20 100644 --- a/exchange/exchange-ps/exchange/New-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxExportRequest.md @@ -409,6 +409,8 @@ Accept wildcard characters: False ``` ### -ContentFilter +**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. diff --git a/exchange/exchange-ps/exchange/New-MailboxImportRequest.md b/exchange/exchange-ps/exchange/New-MailboxImportRequest.md index 30ef36b1fb..f037f6aba2 100644 --- a/exchange/exchange-ps/exchange/New-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxImportRequest.md @@ -16,7 +16,7 @@ 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://learn.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://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). diff --git a/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md index 4295304624..b5e267cdc2 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md @@ -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 ``` diff --git a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md index c63c5fb69a..43a1b13892 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md @@ -16,7 +16,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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 ] @@ -219,11 +227,14 @@ To view disabled mailboxes, run the Get-MailboxStatistics cmdlet against a datab You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or 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://learn.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. @@ -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 ce400a09e8..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://learn.microsoft.com/powershell/module/exchange/new-mailboxsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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,7 +16,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -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 @@ -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://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/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 155bd5afd3..0dd0822a20 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md @@ -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. -- $true: Common attachment blocking is enabled. The file types are defined by the FileTypes parameter. -- $false: Common attachment blocking is disabled. This is the default value. +You specify the file types using the FileTypes parameter. A default list of values is automatically provided, but you can customize it. + +You specify the action for detected files using the FileTypeAction parameter. ```yaml Type: Boolean @@ -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. @@ -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. This is the default value. 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: 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, 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://learn.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 bfe1d9ab3f..ad4f6ad019 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/New-MalwareFilterRule.md @@ -39,7 +39,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-malware-protection-about#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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-ManagedFolder.md b/exchange/exchange-ps/exchange/New-ManagedFolder.md index f05836931b..da5d39bc23 100644 --- a/exchange/exchange-ps/exchange/New-ManagedFolder.md +++ b/exchange/exchange-ps/exchange/New-ManagedFolder.md @@ -89,7 +89,7 @@ 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 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. diff --git a/exchange/exchange-ps/exchange/New-ManagementRole.md b/exchange/exchange-ps/exchange/New-ManagementRole.md index 4cf40391ca..84f1b34a67 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRole.md +++ b/exchange/exchange-ps/exchange/New-ManagementRole.md @@ -62,6 +62,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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)"} ``` @@ -116,9 +117,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://learn.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. diff --git a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md index d22beab980..9cd0581b13 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md @@ -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] @@ -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://learn.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://learn.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,7 +561,7 @@ 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://learn.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. diff --git a/exchange/exchange-ps/exchange/New-ManagementScope.md b/exchange/exchange-ps/exchange/New-ManagementScope.md index 868a8a3b12..c2fcc0e2d9 100644 --- a/exchange/exchange-ps/exchange/New-ManagementScope.md +++ b/exchange/exchange-ps/exchange/New-ManagementScope.md @@ -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" ``` @@ -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-MigrationBatch.md b/exchange/exchange-ps/exchange/New-MigrationBatch.md index 3511e3db7f..e17cdd2090 100644 --- a/exchange/exchange-ps/exchange/New-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/New-MigrationBatch.md @@ -20,51 +20,172 @@ For information about the parameter sets in the Syntax section below, see [Excha ## 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] @@ -288,6 +465,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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,8 +487,11 @@ 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.Name ``` @@ -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,8 +546,11 @@ 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 ``` @@ -363,8 +559,11 @@ This example is the same as Example 3, but the CompleteAfter parameter is also u ### 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 ``` @@ -373,9 +572,11 @@ This example is the same as Example 8, but the TimeZone parameter is also used. ### 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 ``` @@ -416,7 +617,7 @@ To disable the migration of the users in the original migration batch, use the D ```yaml Type: MultiValuedProperty -Parameter Sets: Preexisting +Parameter Sets: Preexisting, PreexistingUsers Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -427,6 +628,42 @@ 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 +``` + +### -ManagedGmailTeams +This parameter is available only in the cloud-based service. + +{{ Fill ManagedGmailTeams Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: ManagedGmailTeams +Aliases: +Applicable: Exchange Online + +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. @@ -452,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 @@ -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: @@ -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 @@ -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 @@ -1010,7 +1317,7 @@ Valid input for this parameter is a supported culture code value from the Micros ```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 7c3acce5b6..f7429f506d 100644 --- a/exchange/exchange-ps/exchange/New-MigrationEndpoint.md +++ b/exchange/exchange-ps/exchange/New-MigrationEndpoint.md @@ -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,7 +240,7 @@ 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. @@ -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 ``` @@ -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 c3164efe2b..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://learn.microsoft.com/powershell/module/exchange/new-mobiledevicemailboxpolicy -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 title: New-MobileDeviceMailboxPolicy schema: 2.0.0 author: chrisda @@ -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 a85693198c..85f5f280eb 100644 --- a/exchange/exchange-ps/exchange/New-MoveRequest.md +++ b/exchange/exchange-ps/exchange/New-MoveRequest.md @@ -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 ] @@ -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,7 +604,7 @@ 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). @@ -1076,10 +1081,28 @@ 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). diff --git a/exchange/exchange-ps/exchange/New-OMEConfiguration.md b/exchange/exchange-ps/exchange/New-OMEConfiguration.md index 265b4e6f69..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://learn.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 @@ -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://learn.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-OfflineAddressBook.md b/exchange/exchange-ps/exchange/New-OfflineAddressBook.md index 187bea60cd..cc267ae497 100644 --- a/exchange/exchange-ps/exchange/New-OfflineAddressBook.md +++ b/exchange/exchange-ps/exchange/New-OfflineAddressBook.md @@ -50,6 +50,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell $a = Get-AddressList | Where {$_.Name -Like "*AgencyB*"} + New-OfflineAddressBook -Name "OAB_AgencyB" -Server myserver.contoso.com -AddressLists $a -Schedule "Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00" ``` @@ -406,12 +407,11 @@ Accept wildcard characters: False ### -Versions This parameter is available only in Exchange Server 2010. -The Versions parameter specifies what version of OAB to generate. The allowed values are: +The Versions parameter specifies the OAB versions that are generated for client download. Valid values are: -- Version1 -- Version2 -- Version3 -- Version4 +- Version2 (requires public folder distribution) +- Version3 (requires public folder distribution) +- Version4 (default value) ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md index c49b7da125..a8a5a4ed57 100644 --- a/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md +++ b/exchange/exchange-ps/exchange/New-OnPremisesOrganization.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-onpremisesorganization -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: New-OnPremisesOrganization schema: 2.0.0 author: chrisda @@ -53,7 +53,7 @@ The Name parameter specifies a friendly name for the on-premises Exchange organi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -69,7 +69,7 @@ The HybridDomains parameter specifies the domains that are configured in the hyb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -85,7 +85,7 @@ The InboundConnector parameter specifies the name of the inbound connector confi Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -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 f1ed2792c4..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://learn.microsoft.com/powershell/module/exchange/new-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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 @@ -296,7 +296,7 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso 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 @@ -342,7 +342,7 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso 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 @@ -436,7 +436,7 @@ The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the 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 8e18c87df5..a8a7015875 100644 --- a/exchange/exchange-ps/exchange/New-OrganizationSegment.md +++ b/exchange/exchange-ps/exchange/New-OrganizationSegment.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-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/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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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,7 +96,7 @@ Accept wildcard characters: False 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://learn.microsoft.com/microsoft-365/compliance/information-barriers-attributes). +- 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). @@ -144,6 +144,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Attributes for information barrier policies](https://learn.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://learn.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-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md index 4b789db3d6..b25a96ccdb 100644 --- a/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md @@ -32,7 +32,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md b/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md index bee46e4e11..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://learn.microsoft.com/powershell/module/exchange/new-phishsimoverridepolicy -applicable: Security & Compliance +applicable: Exchange Online title: New-PhishSimOverridePolicy schema: 2.0.0 author: chrisda @@ -12,9 +12,9 @@ ms.reviewer: # New-PhishSimOverridePolicy ## 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). +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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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-ProtectionAlert.md b/exchange/exchange-ps/exchange/New-ProtectionAlert.md index 26a005a74c..5c469a4905 100644 --- a/exchange/exchange-ps/exchange/New-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/New-ProtectionAlert.md @@ -14,7 +14,17 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-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. + +> [!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). @@ -53,7 +63,7 @@ New-ProtectionAlert -Category -Name -NotifyUser -TargetMailbox [-DomainController ] [-InternalFlags ] [-Name ] + [[-Organization] ] [-Priority ] [-RequestExpiryInterval ] [-Suspend] @@ -43,7 +44,7 @@ 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. @@ -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 d39df532ec..2ce42db98f 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePermissions.md +++ b/exchange/exchange-ps/exchange/New-QuarantinePermissions.md @@ -14,7 +14,9 @@ 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. + +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). @@ -22,13 +24,14 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` New-QuarantinePermissions - [-PermissionToBlockSender ] - [-PermissionToDelete ] - [-PermissionToDownload ] - [-PermissionToPreview ] - [-PermissionToRelease ] - [-PermissionToRequestRelease ] - [-PermissionToViewHeader ] + [[-PermissionToAllowSender] ] + [[-PermissionToBlockSender] ] + [[-PermissionToDelete] ] + [[-PermissionToDownload] ] + [[-PermissionToPreview] ] + [[-PermissionToRelease] ] + [[-PermissionToRequestRelease] ] + [[-PermissionToViewHeader] ] [] ``` @@ -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 de8dedd8bf..1d12b70c98 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md @@ -31,20 +31,24 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 49b482d5b2..a053087232 100644 --- a/exchange/exchange-ps/exchange/New-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/New-ReceiveConnector.md @@ -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. diff --git a/exchange/exchange-ps/exchange/New-RemoteMailbox.md b/exchange/exchange-ps/exchange/New-RemoteMailbox.md index 0c433429fe..2647a103bb 100644 --- a/exchange/exchange-ps/exchange/New-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/New-RemoteMailbox.md @@ -164,6 +164,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 index 758b9186ff..6ae7128ad5 100644 --- a/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md @@ -43,6 +43,7 @@ New-ReportSubmissionPolicy [-OnlyShowPhishingDisclaimer ] [-PhishingReviewResultMessage ] [-PostSubmitMessage ] + [-PostSubmitMessageEnabled ] [-PostSubmitMessageForJunk ] [-PostSubmitMessageForNotJunk ] [-PostSubmitMessageForPhishing ] @@ -51,6 +52,7 @@ New-ReportSubmissionPolicy [-PostSubmitMessageTitleForNotJunk ] [-PostSubmitMessageTitleForPhishing ] [-PreSubmitMessage ] + [-PreSubmitMessageEnabled ] [-PreSubmitMessageForJunk ] [-PreSubmitMessageForNotJunk ] [-PreSubmitMessageForPhishing ] @@ -58,6 +60,8 @@ New-ReportSubmissionPolicy [-PreSubmitMessageTitleForJunk ] [-PreSubmitMessageTitleForNotJunk ] [-PreSubmitMessageTitleForPhishing ] + [-ReportChatMessageEnabled ] + [-ReportChatMessageToCustomizedAddressEnabled ] [-ReportJunkAddresses ] [-ReportJunkToCustomizedAddress ] [-ReportNotJunkAddresses ] @@ -71,11 +75,11 @@ New-ReportSubmissionPolicy ``` ## DESCRIPTION -The report submission policy controls most of the settings for user submissions in the Microsoft 365 Defender portal at . +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 365 Defender portal at , the same email address is also set in the following parameters in the \*-ReportSubmissionPolicy cmdlets: +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. @@ -86,10 +90,10 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -New-ReportSubmissionPolicy +New-ReportSubmissionPolicy ``` -This example creates the one and only report submission policy named DefaultReportSubmissionPolicy with the default values: the Microsoft integrated reporting experience is on, Microsoft reporting tools in Outlook are used, and reported messages are sent only to Microsoft (the reporting mailbox isn't used). +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 @@ -100,7 +104,7 @@ New-ReportSubmissionPolicy -ReportJunkToCustomizedAddress $true -ReportJunkAddre New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub ``` -This example creates the report submission policy with the following values: the Microsoft integrated reporting experience is on, Microsoft reporting tools in Outlook are used, and reported messages are sent to Microsoft and the specified reporting mailbox in Exchange Online. +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**: @@ -117,7 +121,7 @@ New-ReportSubmissionPolicy -EnableReportToMicrosoft $false -ReportJunkToCustomiz New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub ``` -This example creates the report submission policy with the following values: the Microsoft integrated reporting experience is on, Microsoft reporting tools in Outlook are used, and reported messages are sent only to the specified reporting mailbox in Exchange Online. +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 @@ -128,14 +132,14 @@ New-ReportSubmissionPolicy -EnableReportToMicrosoft $false -EnableThirdPartyAddr New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub ``` -This example creates the report submission policy with the following values: the Microsoft integrated reporting experience is on and third-party reporting tools in Outlook are used to send reported messages to the specified reporting mailbox in Exchange Online. +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: the Microsoft integrated reporting experience 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 365 Defender portal. +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 @@ -145,7 +149,7 @@ The DisableQuarantineReportingOption parameter allows or prevents users from rep - $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 the Microsoft integrated reporting experience is enabled as described in the EnableReportToMicrosoft parameter. +This parameter is meaningful only reporting in Outlook is enabled as described in the EnableReportToMicrosoft parameter. ```yaml Type: Boolean @@ -219,7 +223,7 @@ The EnableOrganizationBranding parameter specifies whether to show the company l - $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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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: Boolean @@ -237,15 +241,15 @@ 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 the Microsoft integrated reporting experience. The following configurations are possible: +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 the Microsoft integrated reporting experience. The following configurations are possible: +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. -- **The Microsoft integrated reporting experience 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 365 Defender portal**: The EnableThirdPartyAddress, ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. +- **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). @@ -265,7 +269,7 @@ 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: The Microsoft integrated reporting experience 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. +- $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). @@ -293,7 +297,7 @@ Use the JunkReviewResultMessage, NotJunkReviewResultMessage, PhishingReviewResul Use the NotificationFooterMessage parameter for the footer that's used for all verdicts (junk, not junk, and phishing). -This parameter is meaningful only when the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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: Boolean @@ -311,7 +315,7 @@ 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. +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. @@ -333,7 +337,7 @@ 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. +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. @@ -357,7 +361,7 @@ The NotificationFooterMessage parameter specifies the custom footer text to use 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. +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 @@ -375,7 +379,7 @@ 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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: MultiValuedProperty @@ -473,7 +477,7 @@ 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. +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. @@ -497,7 +501,7 @@ The PostSubmitMessage parameter specifies the custom pop-up message text to use You specify the custom pop-up message title using the PostSubmitMessageTitle parameter. -This parameter is meaningful only when the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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 @@ -512,6 +516,22 @@ 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. @@ -565,7 +585,7 @@ The PostSubmitMessage parameter parameter specifies the custom pop-up message ti You specify the custom pop-up message text using the PostSubmitMessage parameter. -This parameter is meaningful only when the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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 @@ -633,7 +653,7 @@ The PreSubmitMessage parameter specifies the custom pop-up message text to use i You specify the custom pop-up message title using the PreSubmitMessageTitle parameter. -This parameter is meaningful only when the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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 @@ -648,6 +668,22 @@ 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. @@ -701,7 +737,7 @@ The PreSubmitMessage parameter parameter specifies the custom pop-up message tit You specify the pop-up message text using the PreSubmitMessage parameter. -This parameter is meaningful only when the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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 @@ -764,8 +800,40 @@ 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 the Microsoft integrated reporting experience using Microsoft or third-party reporting tools in Outlook. +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. @@ -787,14 +855,14 @@ 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 the Microsoft integrated reporting experience. Valid values are: +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 the Microsoft integrated reporting experience (see the EnableReportToMicrosoft parameter) and sending reported messages to the reporting mailbox (exclusively or in addition to reporting to Microsoft). +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 @@ -810,7 +878,7 @@ 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 the Microsoft integrated reporting experience using Microsoft or third-party reporting tools in Outlook. +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. @@ -832,14 +900,14 @@ 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 the Microsoft integrated reporting experience. Valid values are: +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 the Microsoft integrated reporting experience (see the EnableReportToMicrosoft parameter) and sending reported messages to the reporting mailbox (exclusively or in addition to reporting to Microsoft). +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 @@ -855,7 +923,7 @@ 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 the Microsoft integrated reporting experience using Microsoft or third-party reporting tools in Outlook. +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. @@ -877,14 +945,14 @@ 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 the Microsoft integrated reporting experience. Valid values are: +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 the Microsoft integrated reporting experience (see the EnableReportToMicrosoft parameter) and sending reported messages to the reporting mailbox (exclusively or in addition to reporting to Microsoft). +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 @@ -900,9 +968,9 @@ 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 the Microsoft integrated reporting experience. +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 the Microsoft integrated reporting experience (`-EnableReportToMicrosoft $false`) and you're using the reporting mailbox with third-party tools (`-EnableThirdPartyAddress $true`). +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 diff --git a/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md index 425c277b7d..9128905359 100644 --- a/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md +++ b/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md @@ -9,7 +9,6 @@ ms.author: chrisda ms.reviewer: --- - # New-ReportSubmissionRule ## SYNOPSIS @@ -37,11 +36,11 @@ New-ReportSubmissionRule [-Name] -ReportSubmissionPolicy , the same email address is also set in the *\-ReportSubmissionPolicy cmdlets: +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. @@ -54,7 +53,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SendTo "userreportedmessages@contoso.onmicrosoft.com" +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. @@ -152,12 +151,12 @@ 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 the Microsoft integrated reporting experience is enabled, and user reported messages are sent to a reporting mailbox as configured in the \*-ReportSubmissionPolicy cmdlets (either of the following scenarios): +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 365 Defender portal, the following parameters in the *\-ReportSubmissionPolicy cmdlets are set to the same value: +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. diff --git a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md index a24a6a7f62..80238a5236 100644 --- a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission/new-retentioncompliancerule). 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To 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,6 +409,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 +``` + ### -PolicyTemplateInfo This parameter is reserved for internal Microsoft use. @@ -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 ba459a0d0e..c7471abe72 100644 --- a/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md @@ -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 [-Action ] - [-ActionOnError ] [-AdminDisplayName ] [-Confirm] [-Enable ] @@ -37,9 +36,9 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-attachments-about). +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. @@ -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. This action will be deprecated. For more information, see [MC424901](https://admin.microsoft.com/AdminPortal/Home#/MessageCenter/:/messages/MC424901). -- 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/microsoft-365/security/office-365-security/safe-attachments-about#dynamic-delivery-in-safe-attachments-policies). +- 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://learn.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,18 +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. -**Note**: Redirection will soon be available only for the Allow action. For more information, see [MC424899](https://admin.microsoft.com/AdminPortal/Home?#/MessageCenter/:/messages/MC424899). - ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -255,15 +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. -**Note**: Redirection will soon be available only for the Allow action. For more information, see [MC424899](https://admin.microsoft.com/AdminPortal/Home?#/MessageCenter/:/messages/MC424899). +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 @@ -279,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 4b6098cc29..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://learn.microsoft.com/powershell/module/exchange/new-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: New-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -41,10 +41,10 @@ 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://learn.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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 8a9befb2f5..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://learn.microsoft.com/powershell/module/exchange/new-safelinkspolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: New-SafeLinksPolicy schema: 2.0.0 author: chrisda @@ -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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-links-about#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 @@ -234,13 +238,13 @@ Accept wildcard characters: False 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://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. +- $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://learn.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 b9bf1b9e7e..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://learn.microsoft.com/powershell/module/exchange/new-safelinksrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: New-SafeLinksRule schema: 2.0.0 author: chrisda @@ -42,7 +42,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-links-about#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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/New-SecOpsOverridePolicy.md index 05d37e1c17..e24f5206c9 100644 --- a/exchange/exchange-ps/exchange/New-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/exchange/New-SecOpsOverridePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-secopsoverridepolicy -applicable: Security & Compliance +applicable: Exchange Online title: New-SecOpsOverridePolicy schema: 2.0.0 author: chrisda @@ -12,9 +12,9 @@ ms.reviewer: # New-SecOpsOverridePolicy ## 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). +This cmdlet is available only in the cloud-based service. -Use the New-SecOpsOverridePolicy cmdlet to create 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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +Use the New-SecOpsOverridePolicy cmdlet to create 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -24,19 +24,21 @@ For information about the parameter sets in the Syntax section below, see [Excha New-SecOpsOverridePolicy [-Name] -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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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-SendConnector.md b/exchange/exchange-ps/exchange/New-SendConnector.md index 0859710d56..bb0b4fa218 100644 --- a/exchange/exchange-ps/exchange/New-SendConnector.md +++ b/exchange/exchange-ps/exchange/New-SendConnector.md @@ -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 ``` diff --git a/exchange/exchange-ps/exchange/New-ServicePrincipal.md b/exchange/exchange-ps/exchange/New-ServicePrincipal.md index 009f888e4f..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://learn.microsoft.com/powershell/module/exchange/new-serviceprincipal -applicable: Exchange Online +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: New-ServicePrincipal schema: 2.0.0 author: chrisda @@ -21,7 +21,8 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -New-ServicePrincipal -AppId -ServiceId +New-ServicePrincipal -AppId -ObjectId + -ServiceId [-Confirm] [-DisplayName ] [-Organization ] @@ -30,9 +31,9 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -40,10 +41,10 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 @@ -52,14 +53,14 @@ The AppId parameter specifies the unique AppId GUID value for the service princi A valid value for this parameter is available in the following locations: -- The AppId property in the output of the Get-AzureADApplication cmdlet in the AzureAD PowerShell module. For installation instructions, see [Install Azure Active Directory PowerShell for Graph](https://learn.microsoft.com/powershell/azure/active-directory/install-adv2). -- The Application ID property from Enterprise applications in the Azure AD portal: . +- 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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -68,17 +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 -- The ObjectId property in the output of the Get-AzureADApplication cmdlet in the AzureAD PowerShell module. For installation instructions, see [Install Azure Active Directory PowerShell for Graph](https://learn.microsoft.com/powershell/azure/active-directory/install-adv2). -- The Object ID property from Enterprise applications in the Azure AD portal: . +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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -97,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 Online +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -113,7 +132,7 @@ The DisplayName parameter specifies the friendly name of the service principal. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -129,7 +148,7 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Security & Compliance Required: False Position: Named @@ -145,7 +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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-SharingPolicy.md b/exchange/exchange-ps/exchange/New-SharingPolicy.md index 5057976d77..c955830dfd 100644 --- a/exchange/exchange-ps/exchange/New-SharingPolicy.md +++ b/exchange/exchange-ps/exchange/New-SharingPolicy.md @@ -16,6 +16,8 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-SharingPolicy cmdlet to create a sharing policy to regulate how users inside your organization can share calendar and contact information with users outside the organization. Users can only share this information after federation has been configured in Exchange. After federation is configured, users can send sharing invitations that comply with a sharing policy to external recipients in other Exchange Server 2010 or later organizations that have federation enabled. A sharing policy needs to get assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the level of sharing permitted for this mailbox. +Sharing policies provide user-established, people-to-people sharing of both calendar and contact information with different types of external users. Sharing policies allow users to share both their free/busy and contact information (including the Calendar and Contacts folders) with recipients in other external federated Exchange organizations. For recipients that aren't in an external federated organization or are in non-Exchange organizations, sharing policies allow people-to-people sharing of their calendar information with anonymous users through the use of Internet Calendar Publishing. + For 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-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md index e25c835181..ed8687d950 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 3c99412420..c4b9d1a57f 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md @@ -22,20 +22,33 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 840964a331..6aa53c55aa 100644 --- a/exchange/exchange-ps/exchange/New-SweepRule.md +++ b/exchange/exchange-ps/exchange/New-SweepRule.md @@ -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 898de80764..8084e8b744 100644 --- a/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md +++ b/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md @@ -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://learn.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 cc26cff6bb..05d97b7970 100644 --- a/exchange/exchange-ps/exchange/New-SystemMessage.md +++ b/exchange/exchange-ps/exchange/New-SystemMessage.md @@ -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 10d633ce40..6ef2975372 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -26,8 +26,10 @@ New-TenantAllowBlockListItems -Entries -ListType [-Expirat [-Allow] [-Block] [-ListSubType ] + [-LogExtraDetails] [-Notes ] [-OutputJson] + [-RemoveAfter ] [-SubmissionID ] [] ``` @@ -38,8 +40,10 @@ New-TenantAllowBlockListItems -Entries -ListType [-NoExpir [-Allow] [-Block] [-ListSubType ] + [-LogExtraDetails] [-Notes ] [-OutputJson] + [-RemoveAfter ] [-SubmissionID ] [] ``` @@ -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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +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://learn.microsoft.com/microsoft-365/security/office-365-security/tenant-allow-block-list-urls-configure#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. + +The maximum number of characters in a file entry is 64 and the maximum number of characters in a URL entry is 250. -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). +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://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 @@ -165,17 +195,19 @@ Accept wildcard characters: False ``` ### -Allow -This parameter is available only in Exchange Online PowerShell. - The Allow switch specifies that you're creating an allow entry. You don't need to specify a value with this switch. You can't use this switch with the Block switch. +**Note**: See [Allow entries in the Tenant Allow/Block List](https://learn.microsoft.com/defender-office-365/tenant-allow-block-list-about#allow-entries-in-the-tenant-allowblock-list), before you try to create an allow entry. + +You can also use allow entries for third-party phishing simulation URLs with no expiration. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -203,17 +235,31 @@ Accept wildcard characters: False ``` ### -ListSubType -This parameter is available only in Exchange Online PowerShell. - 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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +- 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 @@ -239,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. @@ -258,15 +326,13 @@ Accept wildcard characters: False ``` ### -SubmissionID -This parameter is available only in Exchange Online PowerShell. - This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md index 52c829eef0..48976dd565 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md @@ -21,8 +21,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -New-TenantAllowBlockListSpoofItems [-Identity] -Action - -SendingInfrastructure -SpoofedUser -SpoofType +New-TenantAllowBlockListSpoofItems [-Identity] -Action -SendingInfrastructure -SpoofedUser -SpoofType [-Confirm] [-WhatIf] [] @@ -64,7 +63,7 @@ Accept wildcard characters: False The SendingInfrastructure parameter specifies the source of the messages sent by the spoofed sender that's defined in the SpoofedUser parameter. Valid values are: - An email domain (for example contoso.com). The domain is found in the reverse DNS lookup (PTR record) of the source email server's IP address. -- 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. +- 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-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 57e44818e5..97c913ad9b 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -16,6 +16,12 @@ 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. +**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 ] @@ -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,18 +666,23 @@ 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: 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. This is the default value.
• 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. +- 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. - In Exchange Online, we recommend using the value Reject for this parameter. - ```yaml Type: DisclaimerFallbackAction Parameter Sets: (All) @@ -692,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: @@ -717,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 @@ -782,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 ("). @@ -808,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. @@ -830,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) @@ -850,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) @@ -873,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. @@ -896,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://learn.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 @@ -921,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. @@ -945,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"`. @@ -965,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: @@ -990,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: @@ -1061,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: @@ -1090,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: @@ -1183,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. @@ -1278,6 +1321,8 @@ Accept wildcard characters: False ``` ### -DlpPolicy +**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 @@ -1335,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. @@ -1387,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: @@ -1410,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: @@ -1443,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: @@ -1476,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. @@ -1502,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. @@ -1528,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: @@ -1561,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: @@ -1594,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: @@ -1627,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: @@ -1660,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. @@ -1682,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) @@ -1702,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) @@ -1725,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. @@ -1748,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://learn.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 @@ -1773,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. @@ -1797,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"`. @@ -1817,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: @@ -1842,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: @@ -1881,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. @@ -1911,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: @@ -1940,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: @@ -1969,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. @@ -1991,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: @@ -2022,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. @@ -2044,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. @@ -2052,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) @@ -2066,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: @@ -2097,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 @@ -2120,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. @@ -2146,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: @@ -2169,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: @@ -2192,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. @@ -2212,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. @@ -2236,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. @@ -2256,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. @@ -2278,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: @@ -2309,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: @@ -2334,9 +2387,11 @@ 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. @@ -2358,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. @@ -2388,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). @@ -2418,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. @@ -2474,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. @@ -2528,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. @@ -2548,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"`. @@ -2570,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[] @@ -2610,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: @@ -2637,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. @@ -2693,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. @@ -2747,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). @@ -2789,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: @@ -2801,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) @@ -2815,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: @@ -2838,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: @@ -2867,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: @@ -2894,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 @@ -2919,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[] @@ -2941,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. @@ -2961,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[] @@ -2983,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. @@ -3003,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: @@ -3027,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 @@ -3049,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: @@ -3108,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) @@ -3124,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: @@ -3159,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 @@ -3178,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: @@ -3189,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 @@ -3207,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: @@ -3220,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) @@ -3236,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. @@ -3262,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: @@ -3283,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: @@ -3394,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. @@ -3404,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. @@ -3437,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: @@ -3488,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: @@ -3519,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: @@ -3542,9 +3605,11 @@ 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. @@ -3600,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). @@ -3630,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 @@ -3650,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: @@ -3675,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: @@ -3704,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: @@ -3791,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) @@ -3807,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. @@ -3863,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. @@ -3917,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. @@ -3937,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"`. @@ -3961,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 @@ -3980,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[] @@ -4049,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. @@ -4075,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". @@ -4169,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 @@ -4211,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: @@ -4253,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 @@ -4270,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: @@ -4299,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. @@ -4355,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. @@ -4409,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 @@ -4437,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). @@ -4479,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: @@ -4489,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) @@ -4505,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: @@ -4528,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: @@ -4557,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: @@ -4588,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 @@ -4613,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: @@ -4772,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[] @@ -4814,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[] @@ -4887,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-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md index e53c3458c5..4fa9e1f46e 100644 --- a/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md @@ -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-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md index e31a1f886a..2196b0f833 100644 --- a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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://learn.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://learn.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"`. diff --git a/exchange/exchange-ps/exchange/New-UnifiedGroup.md b/exchange/exchange-ps/exchange/New-UnifiedGroup.md index 445f7e06d8..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://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: New-UnifiedGroup schema: 2.0.0 author: chrisda @@ -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://learn.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 @@ -450,7 +449,7 @@ You can use this setting to help comply with regulations that require you to hid 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 @@ -484,7 +483,7 @@ Valid input for this parameter is a supported culture code value from the Micros 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,8 +644,6 @@ 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. **Note**: In the output of the Get-UnifiedGroup cmdlet, this property is named SensitivityLabel, not SensitivityLabelId. @@ -657,7 +652,7 @@ The SensitivityLabelId parameter specifies the GUID value of the sensitivity lab Type: System.Guid Parameter Sets: Identity, SegmentationOption, ProvisioningOptions Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -673,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 @@ -689,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 @@ -705,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/Preview-QuarantineMessage.md b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md index c349974be2..655b0da6f5 100644 --- a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Preview-QuarantineMessage -Identity + [-EntityType ] [-RecipientAddress ] [] ``` @@ -65,6 +66,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. @@ -72,7 +94,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/Release-QuarantineMessage.md b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md index adffd6b21f..17f3d5590b 100644 --- a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md @@ -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] @@ -101,6 +105,7 @@ This example releases all messages to all original recipients. ### Example 4 ```powershell $q = Get-QuarantineMessage -QuarantineTypes SPOMalware + $q[-1] | Release-QuarantineMessage -ReleaseToAll ``` @@ -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 3155696e89..13ca24fb1e 100644 --- a/exchange/exchange-ps/exchange/Remove-ADPermission.md +++ b/exchange/exchange-ps/exchange/Remove-ADPermission.md @@ -63,7 +63,7 @@ Remove-ADPermission [[-Identity] ] -Instance ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-AdaptiveScope.md b/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md index cec73d356c..6716aabc5e 100644 --- a/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md +++ b/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-App.md b/exchange/exchange-ps/exchange/Remove-App.md index 0b515accf1..c24c1658e5 100644 --- a/exchange/exchange-ps/exchange/Remove-App.md +++ b/exchange/exchange-ps/exchange/Remove-App.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Remove-App [-Identity] + [-AppType ] [-Confirm] [-DomainController ] [-Mailbox ] @@ -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 4eff897370..c470a3f9f2 100644 --- a/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 4932b1a471..724cda7063 100644 --- a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 e8d3235da0..9b1bae6a1a 100644 --- a/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md @@ -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-AuditConfigurationPolicy.md b/exchange/exchange-ps/exchange/Remove-AuditConfigurationPolicy.md deleted file mode 100644 index 1e998c029a..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://learn.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://learn.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://learn.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://learn.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 df87d5929d..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://learn.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://learn.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://learn.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://learn.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-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md index e8d070c304..7881265a05 100644 --- a/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md @@ -23,6 +23,8 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Remove-AuthenticationPolicy [-Identity] [-Confirm] + [-AllowLegacyExchangeTokens] + [-TenantId ] [-WhatIf] [] ``` @@ -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 6c513e22e0..d6b2940550 100644 --- a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 df4dca37d9..f779597117 100644 --- a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 f2df6b4764..948dcc21f7 100644 --- a/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md b/exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md index 0d5ff96d01..f51da6fded 100644 --- a/exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md +++ b/exchange/exchange-ps/exchange/Remove-AvailabilityConfig.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Remove-AvailabilityConfig cmdlet to remove an availability configuration. An availability configuration specifies an existing account that's used to exchange free/busy information between organizations. +Use the Remove-AvailabilityConfig cmdlet to remove 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -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-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-CalendarEvents.md b/exchange/exchange-ps/exchange/Remove-CalendarEvents.md index 8930143e29..c199b24fec 100644 --- a/exchange/exchange-ps/exchange/Remove-CalendarEvents.md +++ b/exchange/exchange-ps/exchange/Remove-CalendarEvents.md @@ -26,6 +26,7 @@ Remove-CalendarEvents [-Identity] -QueryWindowInDays ] + [-UseCustomRouting] [-WhatIf] [] ``` @@ -165,7 +166,7 @@ Accept wildcard characters: False ### -QueryStartDate The QueryStartDate parameter specifies the start date to look for meetings that you want to cancel. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of 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". **Note**: If you don't use this parameter, today's date is used. @@ -184,6 +185,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 +``` + ### -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-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Remove-CaseHoldPolicy.md index f9e492cdb6..0a3fbdb087 100644 --- a/exchange/exchange-ps/exchange/Remove-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-CaseHoldPolicy.md @@ -31,7 +31,7 @@ Remove-CaseHoldPolicy [-Identity] ## 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 8bed2f1ddf..cb7f9417bd 100644 --- a/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md +++ b/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-ClientAccessRule.md b/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md index 76b1a93a0d..df3b17ddf9 100644 --- a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md @@ -12,6 +12,9 @@ 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. diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceCase.md b/exchange/exchange-ps/exchange/Remove-ComplianceCase.md index dd64d5a958..a636d54a72 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceCase.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 b6a6d38417..2a22dd2318 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 85cac9af1e..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://learn.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 diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md b/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md index 121beb8529..92fdcfc7a7 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md @@ -32,7 +32,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 f94f9e6f85..8140168e36 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 2558276a89..8b38b2ba8a 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 943be2d1a9..46c293ddf7 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceTag.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md index e06d72c688..12423d67fd 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md @@ -37,7 +37,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 6f365743b5..08e72f3b32 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md @@ -37,7 +37,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 d76e4dc2d1..913547d5a2 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md @@ -37,7 +37,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 458f5435cf..d3ab49229c 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md @@ -37,7 +37,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 0afc125657..919b43271d 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md @@ -37,7 +37,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 e5cd3520b0..0fe5232d12 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md @@ -37,7 +37,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md index aa0120a746..86f93677d8 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 fa6db51297..cbbfa8b856 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 22287f6450..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://learn.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 @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.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 ce5a8c201e..9497d5484f 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 cd75af9c5e..e7591b41e1 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DlpPolicy.md @@ -12,9 +12,11 @@ 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. + +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). @@ -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 4c6588d250..6ec3166bac 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md index 5c9a9f592d..248e930c45 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 03db69f265..dcf39f5bd5 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md @@ -30,13 +30,14 @@ Remove-DlpSensitiveInformationTypeRulePackage [-Identity] ] - [-Identity ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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-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 212b5f6107..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://learn.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://learn.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://learn.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 25774e4fef..ba11d899b1 100644 --- a/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md @@ -30,7 +30,7 @@ Remove-EOPProtectionPolicyRule [-Identity] ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md index 47a2d6e071..8389a40fd5 100644 --- a/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Set-AuditConfigurationRule.md b/exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md similarity index 52% rename from exchange/exchange-ps/exchange/Set-AuditConfigurationRule.md rename to exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md index eef243da83..57130dbbe8 100644 --- a/exchange/exchange-ps/exchange/Set-AuditConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md @@ -1,27 +1,27 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/set-auditconfigurationrule -applicable: Security & Compliance -title: Set-AuditConfigurationRule +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: --- -# Set-AuditConfigurationRule +# Remove-ExoPhishSimOverrideRule ## 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). +This cmdlet is available only in the cloud-based service. -Use the Set-AuditConfigurationRule cmdlet to modify audit configuration rules. +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 ``` -Set-AuditConfigurationRule [-Identity] -AuditOperation +Remove-ExoPhishSimOverrideRule [-Identity] [-Confirm] [-DomainController ] [-WhatIf] @@ -29,66 +29,46 @@ Set-AuditConfigurationRule [-Identity] -AuditOperati ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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-AuditConfigurationRule 989a3a6c-dc40-4fa4-8307-beb3ece992e9 -AuditOperation @{Add="CheckOut"} +Get-ExoPhishSimOverrideRule | Remove-ExoPhishSimOverrideRule ``` -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. +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 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 +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: -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` +- Name +- Id +- Distinguished name (DN) +- GUID -### -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. +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: MultiValuedProperty +Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -102,7 +82,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,7 +98,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance +Applicable: Exchange Online Required: False Position: Named @@ -128,13 +108,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/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 67% rename from exchange/exchange-ps/exchange/New-AuditConfigurationPolicy.md rename to exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md index e2de6ce3bc..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://learn.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://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. + +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://learn.microsoft.com/microsoft-365/compliance/microsoft-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-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md index 2b1f219b0d..f4e942a974 100644 --- a/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md @@ -33,7 +33,7 @@ Remove-HoldCompliancePolicy [-Identity] ## 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 73ab3f0816..5b0fea9c47 100644 --- a/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md index 92d102ff02..daac4a22b1 100644 --- a/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md @@ -23,14 +23,15 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Remove-InformationBarrierPolicy [-Identity] [-Confirm] + [-ForceDeletion] [-WhatIf] [] ``` ## DESCRIPTION -For more information, see [Information barrier policies](https://learn.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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) [New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Remove-Label.md b/exchange/exchange-ps/exchange/Remove-Label.md index a66d226ca6..7b1812a00e 100644 --- a/exchange/exchange-ps/exchange/Remove-Label.md +++ b/exchange/exchange-ps/exchange/Remove-Label.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 1a6c208c9e..2289247216 100644 --- a/exchange/exchange-ps/exchange/Remove-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-LabelPolicy.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-MailUser.md b/exchange/exchange-ps/exchange/Remove-MailUser.md index 0098e55975..022d16da1d 100644 --- a/exchange/exchange-ps/exchange/Remove-MailUser.md +++ b/exchange/exchange-ps/exchange/Remove-MailUser.md @@ -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 c087210a76..27447b1e7a 100644 --- a/exchange/exchange-ps/exchange/Remove-Mailbox.md +++ b/exchange/exchange-ps/exchange/Remove-Mailbox.md @@ -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-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md index a4873625ac..3dccb1d13c 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md @@ -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 diff --git a/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md index 21bbafd965..e4a36d24de 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md @@ -16,7 +16,7 @@ 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://learn.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://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). diff --git a/exchange/exchange-ps/exchange/Remove-MailboxPermission.md b/exchange/exchange-ps/exchange/Remove-MailboxPermission.md index e02ec656d7..b6e76be563 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxPermission.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxPermission.md @@ -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 3fecdea794..c9037afa2f 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md @@ -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-MailboxSearch.md b/exchange/exchange-ps/exchange/Remove-MailboxSearch.md index fc190d7ac0..eca5f3db04 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxSearch.md @@ -16,7 +16,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRole.md b/exchange/exchange-ps/exchange/Remove-ManagementRole.md index 14d17e89a9..60ed3913e0 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementRole.md +++ b/exchange/exchange-ps/exchange/Remove-ManagementRole.md @@ -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://learn.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-MigrationBatch.md b/exchange/exchange-ps/exchange/Remove-MigrationBatch.md index f4fdc51adb..7a3f08fc37 100644 --- a/exchange/exchange-ps/exchange/Remove-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Remove-MigrationBatch.md @@ -25,7 +25,7 @@ Remove-MigrationBatch [[-Identity] ] [-Confirm] [-DomainController ] [-Force] - [-Partition + [-Partition ] [-WhatIf] [] ``` diff --git a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md b/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md index 39aaac2ada..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://learn.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 diff --git a/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md index f56f3aaf86..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://learn.microsoft.com/powershell/module/exchange/remove-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -55,7 +55,7 @@ The Identity parameter specifies the identity of the organization relationship t 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 @@ -74,7 +74,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,7 +108,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/Remove-OrganizationSegment.md b/exchange/exchange-ps/exchange/Remove-OrganizationSegment.md index 45515e49fe..0d1f0c04fb 100644 --- a/exchange/exchange-ps/exchange/Remove-OrganizationSegment.md +++ b/exchange/exchange-ps/exchange/Remove-OrganizationSegment.md @@ -28,7 +28,7 @@ Remove-OrganizationSegment [-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.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://learn.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) [New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md index 7546c5ba67..b9f7e4ee5e 100644 --- a/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md @@ -30,7 +30,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md b/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md index e3f7550e0c..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://learn.microsoft.com/powershell/module/exchange/remove-phishsimoverridepolicy -applicable: Security & Compliance +applicable: Exchange Online title: Remove-PhishSimOverridePolicy schema: 2.0.0 author: chrisda @@ -12,9 +12,9 @@ ms.reviewer: # Remove-PhishSimOverridePolicy ## 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). +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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -23,18 +23,20 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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-PhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Remove-PhishSimOverrideRule.md deleted file mode 100644 index acf49b1668..0000000000 --- a/exchange/exchange-ps/exchange/Remove-PhishSimOverrideRule.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-phishsimoverriderule -applicable: Security & Compliance -title: Remove-PhishSimOverrideRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-PhishSimOverrideRule - -## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). - -Use the Remove-PhishSimOverrideRule cmdlet to remove third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-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 - -``` -Remove-PhishSimOverrideRule [-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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Remove-PhishSimOverrideRule -Identity PhishSimOverrideRulea0eae53e-d755-4a42-9320-b9c6b55c5011 -``` - -This example remove the phishing simulation override rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the phishing simulation override rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - -- Name -- Id -- Distinguished name (DN) -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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-ProtectionAlert.md b/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md index 9b137bc1a0..f4edc74c13 100644 --- a/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/Remove-PublicFolderClientPermission.md index 9c6df4a3b5..726354e79b 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderClientPermission.md +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderClientPermission.md @@ -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-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md index af1e339208..647e00554d 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md @@ -65,8 +65,6 @@ Get-PublicFolderMailboxMigrationRequest | group TargetMailbox | ?{$_.Count -gt 1 This example returns duplicate public folder migration requests (requests created for the same target mailbox). If the command returns no results, then there are no duplicate migration requests. -The sample script [Remove Duplicate public folder MRS Requests](https://gallery.technet.microsoft.com/scriptcenter/Remove-Duplicate-public-055f0e5e) detects duplicate or orphaned public folder mailbox migration requests and also removes them. - ## PARAMETERS ### -Identity diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/Remove-PublicFolderMoveRequest.md index 11edff7d55..b32e757add 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderMoveRequest.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfoldermoverequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-PublicFolderMoveRequest schema: 2.0.0 author: chrisda @@ -12,7 +12,7 @@ ms.reviewer: # Remove-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 Remove-PublicFolderMoveRequest cmdlet to cancel a mailbox move initiated using the New-MoveRequest cmdlet. After the move has been finalized, you can't undo the move request. @@ -73,7 +73,7 @@ You can't use this parameter with the RequestGuid or 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 @@ -91,7 +91,7 @@ You can't use this parameter with the Identity parameter. Type: Guid 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 @@ -113,7 +113,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 @@ -132,7 +132,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 @@ -142,13 +142,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 @@ -166,7 +168,7 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -182,7 +184,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 diff --git a/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md index 4a74d13fd1..6c828f12bb 100644 --- a/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Remove-QuarantinePolicy cmdlet to remove custom quarantine policies from your cloud-based organization. +Use the Remove-QuarantinePolicy cmdlet to remove quarantine policies 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). diff --git a/exchange/exchange-ps/exchange/Remove-RecipientPermission.md b/exchange/exchange-ps/exchange/Remove-RecipientPermission.md index 435d5e9960..2b1a383994 100644 --- a/exchange/exchange-ps/exchange/Remove-RecipientPermission.md +++ b/exchange/exchange-ps/exchange/Remove-RecipientPermission.md @@ -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] @@ -164,8 +165,24 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -MultiTrustees +{{ Fill MultiTrustees Description }} + +```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 +``` + ### -SkipDomainValidationForMailContact -{{ Fill SkipDomainValidationForMailContact Description }} +The SkipDomainValidationForMailContact switch skips the check that confirms the proxy addresses of the external contact specified by the Identity parameter are in an accepted domain of the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -181,7 +198,7 @@ Accept wildcard characters: False ``` ### -SkipDomainValidationForMailUser -{{ Fill SkipDomainValidationForMailUser Description }} +The SkipDomainValidationForMailUser switch skips the check that confirms the proxy addresses of the mail user specified by the Identity parameter are in an accepted domain of the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -197,7 +214,7 @@ Accept wildcard characters: False ``` ### -SkipDomainValidationForSharedMailbox -{{ Fill SkipDomainValidationForSharedMailbox Description }} +The SkipDomainValidationForSharedMailbox switch skips the check that confirms the proxy addresses of the shared mailbox specified by the Identity parameter are in an accepted domain of the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/Remove-RecordLabel.md b/exchange/exchange-ps/exchange/Remove-RecordLabel.md deleted file mode 100644 index 199c3279f6..0000000000 --- a/exchange/exchange-ps/exchange/Remove-RecordLabel.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-recordlabel -applicable: Security & Compliance -title: Remove-RecordLabel -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-RecordLabel - -## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). - -Use the Remove-RecordLabel cmdlet to remove record labels from your organization. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Remove-RecordLabel -ItemUrl -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://learn.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-RemoteMailbox.md b/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md index a516dbd55e..1795e792f9 100644 --- a/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md @@ -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-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md index ff611c9d00..586520eb81 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 076a0c4266..fd33677240 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md index 3fc02f7aca..30fc9c2297 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md @@ -44,8 +44,11 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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" ``` diff --git a/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md b/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md index 0b6c18d595..34807f1679 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md +++ b/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md @@ -61,7 +61,7 @@ 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://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) -- WhatIf, Confirm and ValidateOnly switches +- [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-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md index 26112c1a25..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://learn.microsoft.com/powershell/module/exchange/remove-safeattachmentpolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Remove-SafeAttachmentPolicy schema: 2.0.0 author: chrisda @@ -29,7 +29,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-attachments-about). +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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 5c3945aaed..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://learn.microsoft.com/powershell/module/exchange/remove-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Remove-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -28,7 +28,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-attachments-about). +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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 79de42112e..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://learn.microsoft.com/powershell/module/exchange/remove-safelinkspolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Remove-SafeLinksPolicy schema: 2.0.0 author: chrisda @@ -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 ce9b7f9865..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://learn.microsoft.com/powershell/module/exchange/remove-safelinksrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Remove-SafeLinksRule schema: 2.0.0 author: chrisda @@ -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-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md index 2c24634408..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://learn.microsoft.com/powershell/module/exchange/remove-secopsoverridepolicy -applicable: Security & Compliance +applicable: Exchange Online title: Remove-SecOpsOverridePolicy schema: 2.0.0 author: chrisda @@ -12,9 +12,9 @@ ms.reviewer: # Remove-SecOpsOverridePolicy ## 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). +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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -23,12 +23,14 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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-SecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Remove-SecOpsOverrideRule.md deleted file mode 100644 index be66f0641f..0000000000 --- a/exchange/exchange-ps/exchange/Remove-SecOpsOverrideRule.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/remove-secopsoverriderule -applicable: Security & Compliance -title: Remove-SecOpsOverrideRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-SecOpsOverrideRule - -## SYNOPSIS -This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). - -Use the Remove-SecOpsOverrideRule cmdlet to remove SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-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 - -``` -Remove-SecOpsOverrideRule [-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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Remove-SecOpsOverrideRule -Identity SecOpsOverrideRule6fed4b63-3563-495d-a481-b24a311f8329 -``` - -This example removes the SecOps mailbox override rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the SecOps override rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - -- Name -- Id -- Distinguished name (DN) -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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-ServicePrincipal.md b/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md index 49d269698d..855f9df7b6 100644 --- a/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/Remove-ServicePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-serviceprincipal -applicable: Exchange Online +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Remove-ServicePrincipal schema: 2.0.0 author: chrisda @@ -48,13 +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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 0 @@ -73,7 +73,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -89,7 +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 +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md index cf885c26af..1bbb2eaf31 100644 --- a/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md index edff677145..131df513a6 100644 --- a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +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-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md index 4c3e67c384..98949a3787 100644 --- a/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md @@ -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-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md index 934489a608..ed810f1d9c 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 31a9aad1f8..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://learn.microsoft.com/powershell/module/exchange/remove-unifiedgroup -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Remove-UnifiedGroup schema: 2.0.0 author: chrisda @@ -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 775e18ac93..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://learn.microsoft.com/powershell/module/exchange/remove-unifiedgrouplinks -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Remove-UnifiedGroupLinks schema: 2.0.0 author: chrisda @@ -14,9 +14,10 @@ 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) 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). +> [!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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -41,7 +42,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Remove-UnifiedGroupLinks -Identity "Legal Department" -LinkType Members -Links laura@contoso.com,julia@contoso.com ``` -This example removes members laura@contoso.com and julia@contoso.com from the Microsoft 365 Group named Legal Department. +This example removes members `laura@contoso.com` and `julia@contoso.com` from the Microsoft 365 Group named Legal Department. ## PARAMETERS @@ -59,7 +60,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 @@ -69,7 +70,7 @@ Accept wildcard characters: False ``` ### -Links -The Links parameter specifies the recipients to remove from the Microsoft 365 Group. You specify whether these recipients are members, owners, or subscribers by using the LinkType parameter. +The Links parameter specifies the recipients to remove from the Microsoft 365 Group. You specify whether these recipients were members, owners, or subscribers by using the LinkType parameter. You can use any value that uniquely identifies the recipient. For example: @@ -82,13 +83,13 @@ You can use any value that uniquely identifies the recipient. For example: 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 must use this parameter with the LinkType parameter, which means the specified recipients will all be removed from the same role in the Microsoft 365 Group (you can't remove different roles from specific recipients in the same command). +You must use this parameter with the LinkType parameter, which means the specified recipients are removed from the same role in the Microsoft 365 Group (you can't remove recipients from different roles in the same command). ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -102,15 +103,15 @@ The LinkType parameter specifies the recipient's role in the Microsoft 365 Group - 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). +- Subscribers: Existing group 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). -You must use this parameter with the LinkType parameter. +You must use this parameter with the Links parameter. ```yaml Type: LinkType Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -129,7 +130,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 @@ -145,7 +146,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-UserPhoto.md b/exchange/exchange-ps/exchange/Remove-UserPhoto.md index 40b6cd8fb4..fa074e42db 100644 --- a/exchange/exchange-ps/exchange/Remove-UserPhoto.md +++ b/exchange/exchange-ps/exchange/Remove-UserPhoto.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/remove-userphoto -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-UserPhoto schema: 2.0.0 author: chrisda @@ -12,9 +12,11 @@ ms.reviewer: # Remove-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 Remove-UserPhoto cmdlet to delete the photo associated with a user's account. The user photo feature 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 (formerly known as Outlook Web App or OWA), Lync, Skype for Business and SharePoint. +Use the Remove-UserPhoto cmdlet to delete the photo associated with a user's account. The user photo feature allows users to associate a picture with their account. User photos appear in client applications, such as Outlook, Microsoft Teams, and SharePoint. + +**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). @@ -47,10 +49,7 @@ Remove-UserPhoto [-Identity] 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://learn.microsoft.com/powershell/module/microsoft.graph.users/remove-mguserphoto) and [Update-MgUserPhoto](https://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md index 08d75fecc6..828137cfb4 100644 --- a/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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/Restore-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md index ee7cc90daf..e7ed934cf1 100644 --- a/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md @@ -134,6 +134,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-DetailsTemplate.md b/exchange/exchange-ps/exchange/Restore-DetailsTemplate.md index c821dce5d4..c064436cf5 100644 --- a/exchange/exchange-ps/exchange/Restore-DetailsTemplate.md +++ b/exchange/exchange-ps/exchange/Restore-DetailsTemplate.md @@ -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 98efc2a37f..8e775b1697 100644 --- a/exchange/exchange-ps/exchange/Restore-Mailbox.md +++ b/exchange/exchange-ps/exchange/Restore-Mailbox.md @@ -271,7 +271,7 @@ Accept wildcard characters: False ``` ### -EndDate -The EndDate parameter specifies the end date for filtering content that will be exported from the source mailbox. Only items in the mailbox whose date is prior to the end date are exported. When you enter a specific date, use the short date format defined in the Regional Options settings configured on the local computer. For example, if your computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. +The EndDate parameter specifies the end date for filtering content that will be exported from the source mailbox. Only items in the mailbox whose date is prior to the end date are exported. When you enter a specific date, use the short date format defined in the Regional Options settings configured on the local computer. For example, if your computer is configured to use the short date format MM/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. ```yaml Type: DateTime diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index e624517fa4..5132660f97 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/Restore-RecoverableItems +online version: https://learn.microsoft.com/powershell/module/exchange/restore-recoverableitems applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Restore-RecoverableItems schema: 2.0.0 @@ -77,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} ``` @@ -180,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 @@ -220,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 @@ -312,6 +313,16 @@ 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 @@ -345,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-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md index 8c6d8cb381..f1d190bae5 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md @@ -16,7 +16,7 @@ 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://learn.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://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). diff --git a/exchange/exchange-ps/exchange/Resume-MoveRequest.md b/exchange/exchange-ps/exchange/Resume-MoveRequest.md index a29ecedb28..81384c86be 100644 --- a/exchange/exchange-ps/exchange/Resume-MoveRequest.md +++ b/exchange/exchange-ps/exchange/Resume-MoveRequest.md @@ -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-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/Resume-PublicFolderMoveRequest.md index 0fb437beb2..af943a8370 100644 --- a/exchange/exchange-ps/exchange/Resume-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/exchange/Resume-PublicFolderMoveRequest.md @@ -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/Rotate-DkimSigningConfig.md b/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md index bb8bee8239..d424e6898b 100644 --- a/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md +++ b/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md @@ -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 e4c01c2466..f42ad8e781 100644 --- a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-AdminAuditLog.md @@ -12,6 +12,9 @@ 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). @@ -39,9 +42,11 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -71,6 +76,7 @@ The command completed successfully ### Example 3 ```powershell $LogEntries = Search-AdminAuditLog -Cmdlets Write-AdminAuditLog + $LogEntries | ForEach { $_.CmdletParameters } ``` @@ -126,7 +132,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". 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: @@ -251,7 +257,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". 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: diff --git a/exchange/exchange-ps/exchange/Search-Mailbox.md b/exchange/exchange-ps/exchange/Search-Mailbox.md index 397817eeb2..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://learn.microsoft.com/powershell/module/exchange/search-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Search-Mailbox schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ 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://learn.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://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). @@ -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 @@ -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 cbc1c8064f..f6ff4a429a 100644 --- a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md @@ -12,6 +12,9 @@ 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. @@ -56,6 +59,8 @@ 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://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://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 2044c603f3..b56afd8580 100644 --- a/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md +++ b/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/module/exchange/get-messagetrackingreport). The message tracking report cmdlets are used by the delivery reports feature. -In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail cmdlets). +In Exchange Online, delivery reports are replaced by message trace (the Get-MessageTraceV2 and Get-MessageTraceDetailV2 cmdlets). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md b/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md index cb8e6fc981..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://learn.microsoft.com/powershell/module/exchange/search-unifiedauditlog -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Search-UnifiedAuditLog schema: 2.0.0 author: chrisda @@ -14,7 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Search-UnifiedAuditLog cmdlet to search the unified audit log. This log contains events from Exchange Online, SharePoint Online, OneDrive for Business, Azure Active Directory, Microsoft Teams, Power BI, and other Microsoft 365 services. You can search for all events in a specified date range, or you can filter the results based on specific criteria, such as the user who performed the action, the action, or the target object. +Use the Search-UnifiedAuditLog cmdlet to search the unified audit log. This log contains events from Exchange Online, SharePoint, OneDrive, Microsoft Entra ID, Microsoft Teams, Power BI, and other Microsoft 365 services. You can search for all events in a specified date range, or you can filter the results based on specific criteria, such as the user who performed the action, the action, or the target object. + +**Note**: 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). @@ -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,7 +43,7 @@ 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://learn.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://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-reference). @@ -55,44 +59,44 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 @@ -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 @@ -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://learn.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 @@ -237,7 +281,7 @@ The RecordType parameter filters the log entries by record type. For details abo 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/Set-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md index 3af068f0c5..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://learn.microsoft.com/powershell/module/exchange/set-atpbuiltinprotectionrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-ATPBuiltInProtectionRule schema: 2.0.0 author: chrisda @@ -32,10 +32,10 @@ Set-ATPBuiltInProtectionRule [-Identity] ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 88c2891508..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://learn.microsoft.com/powershell/module/exchange/set-atpprotectionpolicyrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-ATPProtectionPolicyRule schema: 2.0.0 author: chrisda @@ -37,10 +37,10 @@ Set-ATPProtectionPolicyRule [-Identity] ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 d0480132f9..d8069d6995 100644 --- a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md +++ b/exchange/exchange-ps/exchange/Set-AcceptedDomain.md @@ -34,6 +34,8 @@ Set-AcceptedDomain [-Identity] [-OutboundOnly ] [-PendingCompletion ] [-PendingRemoval ] + [-SendingFromDomainDisabled ] + [-SendingToDomainDisabled ] [-WhatIf] [] ``` @@ -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 @@ -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 ce515641a9..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://learn.microsoft.com/powershell/module/exchange/set-accesstocustomerdatarequest -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-AccessToCustomerDataRequest schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -54,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 @@ -70,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 @@ -86,7 +86,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 @@ -107,7 +107,7 @@ The ServiceName parameter specifies the related service. Valid values are: Type: Microsoft.Exchange.Management.AccessToCustomerDataApproval.AccessToCustomerDataRequestServiceName 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-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md index a1e87a3f83..e46e295975 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md @@ -60,21 +60,21 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 94e0934d87..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://learn.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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.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://learn.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://learn.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://learn.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-AdaptiveScope.md b/exchange/exchange-ps/exchange/Set-AdaptiveScope.md index e14dfd2626..6560f5f4ab 100644 --- a/exchange/exchange-ps/exchange/Set-AdaptiveScope.md +++ b/exchange/exchange-ps/exchange/Set-AdaptiveScope.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ### 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 +77,35 @@ 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: diff --git a/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md b/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md index f8fc8141c2..6438ed69a2 100644 --- a/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md @@ -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-AdminAuditLogConfig.md b/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md index db7dc2d8ef..6812c3cc6d 100644 --- a/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md +++ b/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md @@ -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 6166091700..a552fa50b5 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md @@ -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 ] @@ -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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-spoofing-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://learn.microsoft.com/microsoft-365/security/office-365-security/email-authentication-about#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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-spoofing-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://learn.microsoft.com/microsoft-365/security/office-365-security/email-authentication-about#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,7 +496,7 @@ 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. @@ -471,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. @@ -490,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: @@ -513,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. @@ -540,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. @@ -560,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: @@ -568,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 @@ -602,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: @@ -647,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 @@ -663,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. @@ -683,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 @@ -708,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: @@ -716,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 @@ -732,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. @@ -752,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. @@ -772,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: @@ -780,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 @@ -797,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: @@ -805,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 @@ -821,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. @@ -829,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 b32e8e58a3..9d41dff174 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishRule.md +++ b/exchange/exchange-ps/exchange/Set-AntiPhishRule.md @@ -39,7 +39,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-phishing-policies-about#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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 52e73da4d8..af5a021961 100644 --- a/exchange/exchange-ps/exchange/Set-App.md +++ b/exchange/exchange-ps/exchange/Set-App.md @@ -48,6 +48,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 ``` diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md index 196d7e454b..d7b88cea53 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md @@ -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://learn.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 b6164f8558..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://learn.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 @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -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://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/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-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 31886611b4..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://learn.microsoft.com/powershell/module/exchange/set-atppolicyforo365 -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-AtpPolicyForO365 schema: 2.0.0 author: chrisda @@ -27,7 +27,6 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Set-AtpPolicyForO365 [[-Identity] ] [-AllowSafeDocsOpen ] - [-BlockUrls ] [-Confirm] [-EnableATPForSPOTeamsODB ] [-EnableSafeDocs ] @@ -36,11 +35,11 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-links-about#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://learn.microsoft.com/microsoft-365/security/office-365-securitysafe-documents-in-e5-plus-security-about). +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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-attachments-for-spo-odfb-teams-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://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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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,30 +91,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockUrls -**Note**: The functionality of this parameter is being replaced by the \*-TenantAllowBlockListItems cmdlets. This parameter now only supports the removal of blocked URLs. Use the \*-TenantAllowBlockListItems cmdlets to add and remove blocked URLs. - -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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-links-about#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. @@ -126,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 @@ -138,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://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. +- $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 @@ -160,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://learn.microsoft.com/microsoft-365/security/office-365-securitysafe-documents-in-e5-plus-security-about) +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 @@ -182,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-AuditConfig.md b/exchange/exchange-ps/exchange/Set-AuditConfig.md index 9a9c0aa0b5..e2c5d20cfd 100644 --- a/exchange/exchange-ps/exchange/Set-AuditConfig.md +++ b/exchange/exchange-ps/exchange/Set-AuditConfig.md @@ -28,7 +28,7 @@ Set-AuditConfig [[-Identity] ] -Workload [] ``` +### 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. @@ -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 e15813338e..5f9a01b922 100644 --- a/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md @@ -34,6 +34,7 @@ Set-AuthenticationPolicy [-Identity] [-AllowBasicAuthRpc] [-AllowBasicAuthSmtp] [-AllowBasicAuthWebServices] + [-AllowLegacyExchangeTokens] [-BlockLegacyAuthActiveSync] [-BlockLegacyAuthAutodiscover] [-BlockLegacyAuthImap] @@ -42,7 +43,17 @@ Set-AuthenticationPolicy [-Identity] [-BlockLegacyAuthPop] [-BlockLegacyAuthRpc] [-BlockLegacyAuthWebServices] + [-BlockLegacyExchangeTokens] + [-BlockModernAuthActiveSync] + [-BlockModernAuthAutodiscover] + [-BlockModernAuthImap] + [-BlockModernAuthMapi] + [-BlockModernAuthOfflineAddressBook] + [-BlockModernAuthPop] + [-BlockModernAuthRpc] + [-BlockModernAuthWebServices] [-Confirm] + [-TenantId ] [-WhatIf] [] ``` @@ -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 7839c1bdb5..08f50e337c 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md @@ -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,8 @@ Set-AutoSensitivityLabelPolicy [-Identity] [-RemoveOneDriveLocationException ] [-RemoveSharePointLocation ] [-RemoveSharePointLocationException ] + [-SharePointAdaptiveScopes ] + [-SharePointAdaptiveScopesException ] [-SpoAipIntegrationEnabled ] [-StartSimulation ] [-WhatIf] @@ -77,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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -86,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 @@ -141,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: `"","",...""`. @@ -159,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: `"","",...""`. @@ -177,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: `"","",...""`. @@ -197,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: `"","",...""`. @@ -231,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. @@ -306,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. @@ -448,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: @@ -470,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: @@ -491,6 +665,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 +``` + ### -PolicyTemplateInfo This parameter is reserved for internal Microsoft use. @@ -552,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: `"","",...""`. @@ -570,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: `"","",...""`. @@ -588,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: `"","",...""`. @@ -606,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: `"","",...""`. @@ -624,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. @@ -643,8 +835,43 @@ 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 -{{ Fill SpoAipIntegrationEnabled Description }} +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 @@ -662,7 +889,7 @@ 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 @@ -670,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 380e49d59e..f477c1b30d 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-AvailabilityConfig.md b/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md index 695147ea1b..7fc266524e 100644 --- a/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md +++ b/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md @@ -21,7 +21,9 @@ For information about the parameter sets in the Syntax section below, see [Excha ## 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. +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-CASMailbox.md b/exchange/exchange-ps/exchange/Set-CASMailbox.md index cc318a3da4..6ff7e5c704 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailbox.md +++ b/exchange/exchange-ps/exchange/Set-CASMailbox.md @@ -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://learn.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 ``` @@ -935,10 +937,10 @@ 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://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). @@ -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 index 087eda2a0a..5901e16225 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md +++ b/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md @@ -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] @@ -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 3fa9a271e6..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://learn.microsoft.com/powershell/module/exchange/set-calendarnotification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-CalendarNotification schema: 2.0.0 author: chrisda @@ -12,10 +12,12 @@ 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. +**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 @@ -45,24 +47,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 a71385f72e..edc2b0bc9a 100644 --- a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md +++ b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md @@ -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 ] @@ -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) @@ -256,7 +284,11 @@ Accept wildcard characters: False The AllowConflicts parameter specifies whether to allow conflicting meeting requests. Valid values are: - $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. +- $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 7c76f1b976..db1f2c2ede 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md @@ -16,6 +16,8 @@ This cmdlet is available only in Security & Compliance PowerShell. For more info Use the Set-CaseHoldPolicy cmdlet to modify existing case hold policies in the Microsoft Purview compliance portal. +**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 @@ -47,7 +49,7 @@ Set-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to 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 $_}`. @@ -61,7 +63,7 @@ Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "K This example makes the following changes to the existing case hold policy named "Regulation 123 Compliance": - Adds the mailbox for the user named Kitty Petersen. -- Adds the SharePoint Online site `https://contoso.sharepoint.com/sites/teams/finance`. +- Adds the SharePoint site `https://contoso.sharepoint.com/sites/teams/finance`. - Removes public folders. - Updates the comment. @@ -88,7 +90,7 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. +The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -117,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://learn.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"`. @@ -151,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 @@ -252,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://learn.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"`. @@ -286,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"`. diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldRule.md b/exchange/exchange-ps/exchange/Set-CaseHoldRule.md index 8c7556cf1a..3935336a80 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldRule.md +++ b/exchange/exchange-ps/exchange/Set-CaseHoldRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://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/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 8535b19be9..1848e06aee 100644 --- a/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md @@ -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 171c4fa736..caa657f795 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessArray.md +++ b/exchange/exchange-ps/exchange/Set-ClientAccessArray.md @@ -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 458f6529e4..9a82144d26 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Set-ClientAccessRule.md @@ -12,6 +12,9 @@ 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. @@ -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 diff --git a/exchange/exchange-ps/exchange/Set-Clutter.md b/exchange/exchange-ps/exchange/Set-Clutter.md index 0c80a092bb..980d6d409c 100644 --- a/exchange/exchange-ps/exchange/Set-Clutter.md +++ b/exchange/exchange-ps/exchange/Set-Clutter.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Set-Clutter -Identity [-Enable ] + [-UseCustomRouting] [] ``` @@ -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-ComplianceCase.md b/exchange/exchange-ps/exchange/Set-ComplianceCase.md index 29f9007172..2975872e51 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceCase.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 a9e7d43bdc..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://learn.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 diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md b/exchange/exchange-ps/exchange/Set-ComplianceSearch.md index b9e57c8e3b..2f6e6859f5 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSearch.md @@ -56,7 +56,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://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/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. @@ -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 bb8e2af626..a490fa06ca 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md @@ -12,6 +12,9 @@ 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. diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md index 358bba3d61..5301f61588 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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. @@ -134,8 +138,8 @@ Accept wildcard characters: False 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://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/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://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. +- 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 67148bff2e..ef1e0e1fd7 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceTag.md @@ -20,13 +20,16 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### Default ``` Set-ComplianceTag [-Identity] + [-AutoApprovalPeriod ] [-Comment ] [-ComplianceTagForNextStage ] [-Confirm] [-EventType ] [-FilePlanProperty ] + [-FlowId ] [-Force] [-MultiStageReviewProperty ] [-Notes ] @@ -36,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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -70,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". @@ -186,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. @@ -244,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-ContentFilterConfig.md b/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md index f62fc986a7..80deb1646f 100644 --- a/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md +++ b/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md @@ -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-DataClassification.md b/exchange/exchange-ps/exchange/Set-DataClassification.md index 305b8ba21c..a31254e845 100644 --- a/exchange/exchange-ps/exchange/Set-DataClassification.md +++ b/exchange/exchange-ps/exchange/Set-DataClassification.md @@ -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 ``` diff --git a/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md b/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md index 2b55e0db42..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://learn.microsoft.com/powershell/module/exchange/set-dataencryptionpolicy -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-DataEncryptionPolicy schema: 2.0.0 author: chrisda @@ -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-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md new file mode 100644 index 0000000000..82ecf059aa --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantbriefingconfig +applicable: Exchange Online +title: Set-DefaultTenantBriefingConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-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 Set-DefaultTenantBriefingConfig cmdlet to modify 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 + +``` +Set-DefaultTenantBriefingConfig -IsEnabledByDefault + [-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 8bde387fdf..e1280caf99 100644 --- a/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md @@ -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-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md index 16d4c698f4..0bbba58e9e 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md @@ -50,7 +50,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 6fd3bea6e8..f9e793ed4e 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md @@ -86,7 +86,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 699b167ab5..ed19ba795f 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md @@ -50,7 +50,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 3ca6ff0148..3ea511f71e 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md @@ -85,7 +85,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 b3a5619c22..4642570323 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md @@ -50,7 +50,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 7bd59f1a4d..e931196275 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md +++ b/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md @@ -41,7 +41,7 @@ The cmdlets in Basic Mobility and Security are described in the following list: 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://learn.microsoft.com/microsoft-365/security/office-365-security/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-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 0aa8b674f3..7d84dcf397 100644 --- a/exchange/exchange-ps/exchange/Set-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Set-DistributionGroup.md @@ -89,6 +89,7 @@ Set-DistributionGroup [-Identity] [-SendOofMessageToOriginatorEnabled ] [-SimpleDisplayName ] [-UMDtmfMap ] + [-UpdateMemberCount] [-WhatIf] [-WindowsEmailAddress ] [] @@ -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 @@ -689,7 +693,7 @@ The Description parameter specifies an optional description for the distribution 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://learn.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,7 +1004,11 @@ Accept wildcard characters: False ### -HiddenGroupMembershipEnabled This parameter is available only in the cloud-based service. -This parameter is reserved for internal Microsoft use. +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 @@ -1110,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 @@ -1129,11 +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. -> -> If the _DL managed by_ or _owner_ is assigned to a security group, and when the owner login to `OWA options -> Distribution group`, they will not see the distribution list under "Distribution groups I own". If the _managed by_ or _owner_ is a normal user instead of a security group, they will be able to see it under "Distribution groups I own". - ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -1438,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. @@ -1645,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-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md index 7d63cdfd60..ef3708c0cf 100644 --- a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to 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 Exchange, 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://learn.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://learn.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://learn.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://learn.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://learn.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://learn.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,6 +643,38 @@ 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 security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. @@ -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,10 +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 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/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 @@ -747,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://learn.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 @@ -769,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://learn.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 @@ -809,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 @@ -849,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://learn.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 @@ -869,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://learn.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 @@ -933,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: `"","",...""`. @@ -951,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: `"","",...""`. @@ -969,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: `"","",...""`. @@ -1005,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://learn.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 @@ -1027,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://learn.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 2dae8ff99e..4a833c4d4b 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -22,22 +22,25 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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 ] @@ -49,10 +52,14 @@ Set-DlpComplianceRule [-Identity] [-DocumentMatchesPatterns ] [-DocumentNameMatchesPatterns ] [-DocumentNameMatchesWords ] - [-DocumentSizeOver ] + [-DocumentSizeOver ] + [-DomainCountOver ] [-EncryptRMSTemplate ] + [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] - [-ExceptIfAccessScope ] + [-EnforcePortalAccess ] + [-EvaluateRulePerComponent ] + [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] [-ExceptIfContentCharacterSetContainsWords ] @@ -69,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 ] @@ -95,48 +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 ] @@ -145,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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -170,7 +189,7 @@ This example modifies the access scope and blocking behavior of a DLP compliance ### Example 2 ```powershell -Contents of the file named C:\Data\Sensitive Type.txt: +# Contents of the file named C:\Data\Sensitive Type.txt: { "Version": "1.0", @@ -229,7 +248,10 @@ Contents of the file named C:\Data\Sensitive Type.txt: } $data = Get-Content -Path "C:\Data\Sensitive Type.txt" -ReadCount 0 -Set-DLPComplianceRule -Identity "Contoso Rule 1" -AdvancedRule $data + +$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")). @@ -265,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 @@ -281,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 @@ -317,7 +339,7 @@ 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 read from a file that contains additional operators and combinations that aren't traditionally supported. +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. @@ -357,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. @@ -394,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 = }`. @@ -416,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: @@ -438,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 @@ -477,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) @@ -509,9 +567,9 @@ 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://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). @@ -529,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. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. +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 @@ -560,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 }} @@ -666,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. @@ -779,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 @@ -791,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 ("). @@ -809,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"=""},...)`. @@ -828,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://learn.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[] @@ -847,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: @@ -855,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 @@ -874,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. @@ -932,9 +1086,9 @@ 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://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). @@ -1070,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. @@ -1183,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 @@ -1284,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 @@ -1366,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 @@ -1398,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 @@ -1434,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. @@ -1484,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. @@ -1530,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 @@ -1550,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. @@ -1600,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. @@ -1804,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.Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. +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. @@ -1831,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 @@ -1847,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 @@ -1942,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 @@ -2078,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 @@ -2086,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[] @@ -2101,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. @@ -2117,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 @@ -2144,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 @@ -2157,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. @@ -2175,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 @@ -2200,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 @@ -2216,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. @@ -2234,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. @@ -2256,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. @@ -2273,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://learn.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 @@ -2293,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. @@ -2310,7 +2585,7 @@ 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://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). @@ -2329,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: @@ -2390,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. @@ -2418,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 @@ -2478,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. @@ -2528,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. @@ -2573,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 @@ -2610,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. @@ -2669,6 +2996,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: @@ -2677,7 +3036,7 @@ The RuleErrorAction parameter specifies what to do if an error is encountered du - 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 @@ -2694,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. @@ -2744,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. @@ -2796,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 @@ -2913,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: @@ -3014,6 +3395,38 @@ 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. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. @@ -3058,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 a0aa001b39..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://learn.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 @@ -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://learn.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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 3f57798989..aa9f4a5616 100644 --- a/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 cdae71087c..74002da4a2 100644 --- a/exchange/exchange-ps/exchange/Set-DlpPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DlpPolicy.md @@ -12,9 +12,11 @@ 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. + +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). @@ -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 785ac00950..e6a09ab1b6 100644 --- a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md @@ -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] [] ``` @@ -55,10 +59,15 @@ This example removes the existing Spanish translation from the sensitive informa ### Example 3 ```powershell $Benefits_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Benefits Template.docx') + $Benefits_Fingerprint = New-DlpFingerprint -FileData $Benefits_Template -Description "Contoso Benefits Template" + $Contoso_Confidential = Get-DlpSensitiveInformationType "Contoso Confidential" + $Array = [System.Collections.ArrayList]($Contoso_Confidential.Fingerprints) + $Array.Add($Benefits_FingerPrint[0]) + Set-DlpSensitiveInformationType $Contoso_Confidential.Identity -FingerPrints $Array ``` @@ -67,9 +76,13 @@ This example modifies the existing sensitive information type rule named "Contos ### Example 4 ```powershell $cc = Get-DlpSensitiveInformationType "Contoso Confidential" + $a = [System.Collections.ArrayList]($cc.Fingerprints) + $a + $a.RemoveAt(0) + Set-DlpSensitiveInformationType $cc.Identity -FingerPrints $a ``` @@ -105,6 +118,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) @@ -134,6 +149,22 @@ 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 +``` + ### -Fingerprints The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the sensitive information type rule. For instructions on how to import documents to use as templates for fingerprints, see [New-DlpFingerprint](https://learn.microsoft.com/powershell/module/exchange/new-dlpfingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing sensitive information type rule, see the Examples section. @@ -150,6 +181,22 @@ 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 adds or removes languages that are associated with the sensitive information type rule. @@ -190,6 +237,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Threshold +{{ Fill Threshold Description }} + +```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 +``` + +### -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/Set-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md index 003eb3dbe8..944203816e 100644 --- a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md @@ -30,7 +30,7 @@ Set-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 98be065faf..4b26f36939 100644 --- a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md @@ -103,6 +103,7 @@ Set-DynamicDistributionGroup [-Identity] [-SendOofMessageToOriginatorEnabled ] [-SimpleDisplayName ] [-UMDtmfMap ] + [-UpdateMemberCount] [-WhatIf] [-WindowsEmailAddress ] [] @@ -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://learn.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 @@ -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 9a09550acb..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://learn.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://learn.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://learn.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 d2d171e3e2..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://learn.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://learn.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://learn.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 67f4e04da8..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://learn.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://learn.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://learn.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 a2d0bb81f7..2f487200f3 100644 --- a/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md @@ -37,10 +37,10 @@ Set-EOPProtectionPolicyRule [-Identity] ``` ## DESCRIPTION -For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 1bc8907539..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://learn.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://learn.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://learn.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 02d9aa707b..3383449510 100644 --- a/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md @@ -38,6 +38,7 @@ Set-EcpVirtualDirectory [-Identity] [-FormsAuthentication ] [-GzipLevel ] [-InternalUrl ] + [-OAuthAuthentication ] [-OwaOptionsEnabled ] [-WhatIf] [-WindowsAuthentication ] @@ -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-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md index af53862c1a..3d157d6042 100644 --- a/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -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 diff --git a/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md b/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md index f23b17f1a3..77225894de 100644 --- a/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md @@ -12,7 +12,7 @@ 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. 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 34505a7f63..b010016da0 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeServer.md +++ b/exchange/exchange-ps/exchange/Set-ExchangeServer.md @@ -34,6 +34,7 @@ Set-ExchangeServer [-Identity] [-MitigationsEnabled ] [-MonitoringGroup ] [-ProductKey ] + [-RingLevel ] [-StaticConfigDomainController ] [-StaticDomainControllers ] [-StaticExcludedDomainControllers ] @@ -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 148cc5f5ad..436392e2c0 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeSettings.md +++ b/exchange/exchange-ps/exchange/Set-ExchangeSettings.md @@ -183,7 +183,7 @@ Set-ExchangeSettings [-Identity] -Reason ### EnableSettingsGroup ``` Set-ExchangeSettings [-Identity] -Reason - [-EnableGroup + [-EnableGroup ] [-DisableGroup ] [-Confirm] [-DomainController ] @@ -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) diff --git a/exchange/exchange-ps/exchange/Set-PhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md similarity index 68% rename from exchange/exchange-ps/exchange/Set-PhishSimOverrideRule.md rename to exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md index 9473d34f3a..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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +Use the Set-ExoPhishSimOverrideRule cmdlet to modify third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 56% rename from exchange/exchange-ps/exchange/Set-SecOpsOverrideRule.md rename to exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md index 63320866b2..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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +Use the Set-ExoSecOpsOverrideRule cmdlet to modify SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +**Tip**: This cmdlet doesn't modify email addresses in the SecOps override rule. To modify the email addresses in the SecOps override rule, use the Set-SecOpsOverridePolicy cmdlet. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 cfe5f7c057..83221e105b 100644 --- a/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md +++ b/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md @@ -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 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-FederationTrust.md b/exchange/exchange-ps/exchange/Set-FederationTrust.md index f3b991d5e6..5a6e6a3d8a 100644 --- a/exchange/exchange-ps/exchange/Set-FederationTrust.md +++ b/exchange/exchange-ps/exchange/Set-FederationTrust.md @@ -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-FocusedInbox.md b/exchange/exchange-ps/exchange/Set-FocusedInbox.md index c0bf3f46e1..daebaa21e2 100644 --- a/exchange/exchange-ps/exchange/Set-FocusedInbox.md +++ b/exchange/exchange-ps/exchange/Set-FocusedInbox.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Set-FocusedInbox -Identity [-FocusedInboxOn ] + [-UseCustomRouting] [] ``` @@ -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-Group.md b/exchange/exchange-ps/exchange/Set-Group.md index 0c6bd31fe1..25c66b6124 100644 --- a/exchange/exchange-ps/exchange/Set-Group.md +++ b/exchange/exchange-ps/exchange/Set-Group.md @@ -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 c0805a36ff..d1f0720b66 100644 --- a/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to 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 438e0f0011..e86f4d51b9 100644 --- a/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://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/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 6d2d48015c..83888c656c 100644 --- a/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md @@ -162,6 +162,8 @@ The IPAllowList parameter specifies IP addresses from which messages are always You can specify multiple IP addresses of the same type separated by commas. For example, `SingleIP1, SingleIP2,...SingleIPN` or `CIDRIP1,CIDRIP2,...CIDRIPN`. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: `@{Add="SingleIP1","IPRange1","CIDRIP1",...}`. +**Note**: IPv6 ranges are not supported. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -184,6 +186,8 @@ The IPBlockList parameter specifies IP addresses from which messages are never a You can specify multiple IP addresses of the same type separated by commas. For example, `SingleIP1, SingleIP2,...SingleIPN` or `CIDRIP1,CIDRIP2,...CIDRIPN`. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: `@{Add="SingleIP1","IPRange1","CIDRIP1",...}`. +**Note**: IPv6 ranges are not supported. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md index f943146bf1..64de11808a 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md @@ -51,6 +51,7 @@ Set-HostedContentFilterPolicy [-Identity] [-IncreaseScoreWithNumericIps ] [-IncreaseScoreWithRedirectToOtherPort ] [-InlineSafetyTipsEnabled ] + [-IntraOrgFilterState ] [-LanguageBlockList ] [-MakeDefault] [-MarkAsSpamBulkMail ] @@ -68,7 +69,7 @@ Set-HostedContentFilterPolicy [-Identity] [-ModifySubjectValue ] [-PhishQuarantineTag ] [-PhishSpamAction ] - [-PhishZapEnabled + [-PhishZapEnabled ] [-QuarantineRetentionPeriod ] [-RedirectToRecipients ] [-RegionBlockList ] @@ -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://learn.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://learn.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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- 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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-spam-bulk-complaint-level-bcl-about). +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://learn.microsoft.com/microsoft-365/security/office-365-security/https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). -- 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://learn.microsoft.com/microsoft-365/security/office-365-security/https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). -- 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://learn.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365) +[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 0da706de32..991cf73ca1 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md +++ b/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md @@ -39,7 +39,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-spam-policies-configure#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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 502b1ceb9b..5a570aaa15 100644 --- a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md @@ -114,11 +114,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://learn.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 @@ -191,7 +191,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://learn.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: @@ -212,7 +212,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://learn.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. diff --git a/exchange/exchange-ps/exchange/Set-HybridMailflow.md b/exchange/exchange-ps/exchange/Set-HybridMailflow.md deleted file mode 100644 index fa9062fea1..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://learn.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://learn.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://learn.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-IRMConfiguration.md b/exchange/exchange-ps/exchange/Set-IRMConfiguration.md index b467a78289..76f288110e 100644 --- a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-IRMConfiguration.md @@ -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 @@ -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) @@ -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-InboundConnector.md b/exchange/exchange-ps/exchange/Set-InboundConnector.md index ecf94c0ca9..285ba184d1 100644 --- a/exchange/exchange-ps/exchange/Set-InboundConnector.md +++ b/exchange/exchange-ps/exchange/Set-InboundConnector.md @@ -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 0130e8102f..fbbb29f2cb 100644 --- a/exchange/exchange-ps/exchange/Set-InboxRule.md +++ b/exchange/exchange-ps/exchange/Set-InboxRule.md @@ -105,7 +105,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 daf292757d..2fbe4dd044 100644 --- a/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md @@ -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://learn.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://learn.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://learn.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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) [New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/set-label.md b/exchange/exchange-ps/exchange/Set-Label.md similarity index 86% rename from exchange/exchange-ps/exchange/set-label.md rename to exchange/exchange-ps/exchange/Set-Label.md index 1b24fbac4a..8424874e92 100644 --- a/exchange/exchange-ps/exchange/set-label.md +++ b/exchange/exchange-ps/exchange/Set-Label.md @@ -37,6 +37,7 @@ Set-Label [-Identity] [-ApplyContentMarkingHeaderFontSize ] [-ApplyContentMarkingHeaderMargin ] [-ApplyContentMarkingHeaderText ] + [-ApplyDynamicWatermarkingEnabled ] [-ApplyWaterMarkingEnabled ] [-ApplyWaterMarkingFontColor ] [-ApplyWaterMarkingFontName ] @@ -50,6 +51,7 @@ Set-Label [-Identity] [-ContentType ] [-DefaultContentLabel ] [-DisplayName ] + [-DynamicWatermarkDisplay ] [-EncryptionContentExpiredOnDateInDaysOrNever ] [-EncryptionDoNotForward ] [-EncryptionDoubleKeyEncryptionUrl ] @@ -81,7 +83,11 @@ Set-Label [-Identity] [-SiteExternalSharingControlType ] [-TeamsAllowedPresenters ] [-TeamsAllowMeetingChat ] + [-TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch ] [-TeamsBypassLobbyForDialInUsers ] + [-TeamsChannelProtectionEnabled ] + [-TeamsChannelSharedWithExternalTenants ] + [-TeamsChannelSharedWithPrivateTeamsOnly ] [-TeamsChannelSharedWithSameLabelOnly ] [-TeamsCopyRestrictionEnforced ] [-TeamsEndToEndEncryptionEnabled ] @@ -98,7 +104,7 @@ Set-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -143,27 +149,29 @@ The AdvancedSettings parameter enables specific features and capabilities for a Specify this parameter with the identity (name or GUID) of the sensitivity label, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. -Some of the settings that you configure with this parameter are supported only by the 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://learn.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: -- **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/microsoft-365/compliance/sensitivity-labels-office-apps#configuring-custom-colors-by-using-powershell). +- **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). -- **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/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). -- **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/microsoft-365/compliance/sensitivity-labels-default-sharing-link). +- **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). -- **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/microsoft-365/compliance/sensitivity-labels-default-sharing-link). +- **DefaultShareLinkPermission**: Specifies the permissions for the sharing link for a site when the label scope includes **Groups & sites**, and the permissions for the sharing link for a document when the label scope includes **Files & emails**. Available values are View and Edit. Example: `Set-Label -Identity General -AdvancedSettings @{DefaultShareLinkPermission="Edit"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). -- **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/microsoft-365/compliance/sensitivity-labels-office-apps#specify-a-default-sublabel-for-a-parent-label). +- **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). -- **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/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: `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). -- **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/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: `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). -- **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/microsoft-365/compliance/sensitivity-labels-office-apps#configure-a-label-to-apply-smime-protection-in-outlook). +- **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). -For more information to help you configure advanced settings for a label, see [PowerShell tips for specifying the advanced settings](https://learn.microsoft.com/microsoft-365/compliance/create-sensitivity-labels#powershell-tips-for-specifying-the-advanced-settings). +- **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 @@ -280,7 +288,7 @@ 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, 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. +**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: System.Int32 @@ -413,7 +421,7 @@ 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, 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. +**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 @@ -446,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: @@ -520,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 @@ -591,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 @@ -628,13 +659,15 @@ Accept wildcard characters: False ### -ContentType 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 @@ -681,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: @@ -877,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 @@ -1277,6 +1335,22 @@ 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: @@ -1297,6 +1371,54 @@ 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 }} diff --git a/exchange/exchange-ps/exchange/Set-LabelPolicy.md b/exchange/exchange-ps/exchange/Set-LabelPolicy.md index cc58656a6a..5b190d2637 100644 --- a/exchange/exchange-ps/exchange/Set-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-LabelPolicy.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to 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 $_ }`. @@ -365,22 +366,28 @@ The AdvancedSettings parameter enables client-specific features and capabilities 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://learn.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: +- **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). + - **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"}`. -- **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/microsoft-365/compliance/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). +- **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/microsoft-365/compliance/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/microsoft-365/compliance/sensitivity-labels-meetings). +- **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/microsoft-365/compliance/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://learn.microsoft.com/power-bi/admin/service-security-sensitivity-label-mandatory-label-policy). @@ -489,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-MailContact.md b/exchange/exchange-ps/exchange/Set-MailContact.md index 34d2bd2b4e..e699c9dec7 100644 --- a/exchange/exchange-ps/exchange/Set-MailContact.md +++ b/exchange/exchange-ps/exchange/Set-MailContact.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-mailcontact -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailContact schema: 2.0.0 author: chrisda @@ -84,6 +84,8 @@ Set-MailContact [-Identity] [-UMDtmfMap ] [-UseMapiRichTextFormat ] [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] [-WhatIf] [-WindowsEmailAddress ] [] @@ -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://learn.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 @@ -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 e8e047cf89..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://learn.microsoft.com/powershell/module/exchange/set-mailpublicfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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://learn.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: @@ -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 a350870c5b..45d451af6c 100644 --- a/exchange/exchange-ps/exchange/Set-MailUser.md +++ b/exchange/exchange-ps/exchange/Set-MailUser.md @@ -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,6 +868,81 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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://learn.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://learn.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 @@ -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://learn.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: diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index d6547b08f3..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://learn.microsoft.com/powershell/module/exchange/set-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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 ] @@ -295,8 +297,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -359,6 +359,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -382,6 +383,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -426,8 +428,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -490,6 +490,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -513,6 +514,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -557,8 +559,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -621,6 +621,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -644,6 +645,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -688,8 +690,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -751,6 +751,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-CreateDTMFMap ] [-CustomAttribute1 ] [-CustomAttribute10 ] @@ -773,6 +774,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -816,8 +818,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -880,6 +880,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -903,6 +904,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -946,8 +948,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -1010,6 +1010,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -1027,12 +1028,13 @@ Set-Mailbox [-Identity] [-CustomAttribute7 ] [-CustomAttribute8 ] [-CustomAttribute9 ] - [-DataEncryptionPolicy + [-DataEncryptionPolicy ] [-DefaultAuditSet ] [-DefaultPublicFolderMailbox ] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -1077,8 +1079,6 @@ Set-Mailbox [-Identity] [-NonCompliantDevices ] [-Office ] [-Password ] - [-PitrCopyIntervalInSeconds ] - [-PitrEnabled ] [-ProhibitSendQuota ] [-ProhibitSendReceiveQuota ] [-ProvisionedForOfficeGraph] @@ -1158,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 ``` @@ -1166,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 ``` @@ -1183,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://learn.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 @@ -1205,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 @@ -1327,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 @@ -1364,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. @@ -1735,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://learn.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 @@ -1958,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. @@ -1988,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 @@ -2315,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://learn.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 @@ -2513,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://learn.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: @@ -2523,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: @@ -2572,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 @@ -2601,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 @@ -2645,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 @@ -2667,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 @@ -3082,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 @@ -3195,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 @@ -3418,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 @@ -3441,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 @@ -3457,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 @@ -3467,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. @@ -3489,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. @@ -3940,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) @@ -3986,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 @@ -4116,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://learn.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://learn.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: @@ -4140,42 +4182,6 @@ 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. @@ -4347,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 @@ -4361,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 @@ -4571,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://learn.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 @@ -4589,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://learn.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 @@ -4637,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 @@ -4677,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 @@ -4878,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 @@ -4890,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. @@ -4941,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 @@ -4975,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: @@ -4983,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) @@ -5066,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. @@ -5232,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 @@ -5332,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 @@ -5371,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. @@ -5395,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 @@ -5472,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 @@ -5565,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 @@ -5690,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 d8015070df..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://learn.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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 9c7fd1ef47..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://learn.microsoft.com/powershell/module/exchange/set-mailboxautoreplyconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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 a206934586..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://learn.microsoft.com/powershell/module/exchange/set-mailboxcalendarconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -49,10 +49,10 @@ Set-MailboxCalendarConfiguration [-Identity] ### Identity ``` Set-MailboxCalendarConfiguration [-Identity] - [-AddOnlineMeetingToAllEvents ] [-AgendaMailEnabled ] [-AgendaMailIntroductionEnabled ] [-AgendaPaneEnabled ] + [-AutoDeclineWhenBusy ] [-CalendarFeedsPreferredLanguage ] [-CalendarFeedsPreferredRegion ] [-CalendarFeedsRootPageId ] @@ -61,8 +61,11 @@ Set-MailboxCalendarConfiguration [-Identity] [-CreateEventsFromEmailAsPrivate ] [-DailyAgendaMailSchedule ] [-DefaultMeetingDuration ] + [-DefaultMinutesToReduceLongEventsBy ] + [-DefaultMinutesToReduceShortEventsBy ] [-DefaultOnlineMeetingProvider ] [-DefaultReminderTime ] + [-DeleteMeetingRequestOnRespond ] [-DiningEventsFromEmailEnabled ] [-EntertainmentEventsFromEmailEnabled ] [-EventsFromEmailEnabled ] @@ -70,12 +73,15 @@ Set-MailboxCalendarConfiguration [-Identity] [-FlightEventsFromEmailEnabled ] [-HotelEventsFromEmailEnabled ] [-InvoiceEventsFromEmailEnabled ] + [-LocationDetailsInFreeBusy ] [-OnlineMeetingsByDefaultEnabled ] [-PackageDeliveryEventsFromEmailEnabled ] + [-PreserveDeclinedMeetings ] [-RemindersEnabled ] [-ReminderSoundEnabled ] [-RentalCarEventsFromEmailEnabled ] [-ServiceAppointmentEventsFromEmailEnabled ] + [-ShortenEventScopeDefault ] [-ShowWeekNumbers ] [-SkipAgendaMailOnFreeDays ] [-TimeIncrement ] @@ -97,10 +103,10 @@ Set-MailboxCalendarConfiguration [-Identity] ### MailboxLocation ``` Set-MailboxCalendarConfiguration [-MailboxLocation ] - [-AddOnlineMeetingToAllEvents ] [-AgendaMailEnabled ] [-AgendaMailIntroductionEnabled ] [-AgendaPaneEnabled ] + [-AutoDeclineWhenBusy ] [-CalendarFeedsPreferredLanguage ] [-CalendarFeedsPreferredRegion ] [-CalendarFeedsRootPageId ] @@ -109,8 +115,11 @@ Set-MailboxCalendarConfiguration [-MailboxLocation ] [-CreateEventsFromEmailAsPrivate ] [-DailyAgendaMailSchedule ] [-DefaultMeetingDuration ] + [-DefaultMinutesToReduceLongEventsBy ] + [-DefaultMinutesToReduceShortEventsBy ] [-DefaultOnlineMeetingProvider ] [-DefaultReminderTime ] + [-DeleteMeetingRequestOnRespond ] [-DiningEventsFromEmailEnabled ] [-EntertainmentEventsFromEmailEnabled ] [-EventsFromEmailEnabled ] @@ -118,12 +127,15 @@ Set-MailboxCalendarConfiguration [-MailboxLocation ] [-FlightEventsFromEmailEnabled ] [-HotelEventsFromEmailEnabled ] [-InvoiceEventsFromEmailEnabled ] + [-LocationDetailsInFreeBusy ] [-OnlineMeetingsByDefaultEnabled ] [-PackageDeliveryEventsFromEmailEnabled ] + [-PreserveDeclinedMeetings ] [-RemindersEnabled ] [-ReminderSoundEnabled ] [-RentalCarEventsFromEmailEnabled ] [-ServiceAppointmentEventsFromEmailEnabled ] + [-ShortenEventScopeDefault ] [-ShowWeekNumbers ] [-SkipAgendaMailOnFreeDays ] [-TimeIncrement ] @@ -190,7 +202,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter 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 @@ -199,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: Identity, MailboxLocation +Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -217,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 @@ -233,10 +245,10 @@ 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 @@ -251,10 +263,10 @@ 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 @@ -335,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 @@ -416,6 +428,42 @@ 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. @@ -452,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. @@ -490,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. @@ -674,6 +740,28 @@ 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. @@ -683,7 +771,7 @@ This parameter is available only in the cloud-based service. Type: MailboxLocationIdParameter Parameter Sets: MailboxLocation Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -741,6 +829,24 @@ 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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemindersEnabled The RemindersEnabled parameter enables or disables reminders for calendar items. Valid values are: @@ -824,6 +930,24 @@ 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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ShowWeekNumbers The ShowWeekNumbers parameter specifies whether the week number is displayed in the Outlook on the web calendar. Valid values are: @@ -1020,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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md index 86f4be66a9..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://learn.microsoft.com/powershell/module/exchange/set-mailboxcalendarfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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. @@ -294,9 +293,10 @@ To specify a date/time value for this parameter, use either of the following opt **Notes**: -- You use this parameter on the shared calendar in delegate's mailbox. For example, `Set-MailboxCalendarFolder -Identity "delegate@contoso.com:\Calendar\Name of shared calendar" -SharedCalendarSyncStartDate`. The word `...\Calendar\...` is in the language that the user sees in Outlook (for example, in German, the word is `...\Kalendar\...`). +- 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-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md index 2ca03b8114..52df63f5f3 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md @@ -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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md index 5584243fdb..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://learn.microsoft.com/powershell/module/exchange/set-mailboxjunkemailconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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,8 +16,6 @@ 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://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 ] @@ -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: @@ -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 c0580067a2..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://learn.microsoft.com/powershell/module/exchange/set-mailboxmessageconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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,7 +91,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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. @@ -974,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 @@ -1120,7 +1183,7 @@ Accept wildcard characters: False ``` ### -SignatureHtml -**Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your 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. @@ -1139,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. @@ -1158,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. @@ -1290,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 fba2644b9a..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://learn.microsoft.com/powershell/module/exchange/set-mailboxplan -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-MailboxPlan schema: 2.0.0 author: chrisda @@ -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 @@ -398,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 bd6a103efd..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://learn.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -20,12 +20,37 @@ For information about the parameter sets in the Syntax section below, see [Excha ## 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 ] @@ -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 @@ -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 @@ -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. @@ -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 cf7b49a6df..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://learn.microsoft.com/powershell/module/exchange/set-mailboxrestorerequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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 @@ -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 a30e7e9cf3..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://learn.microsoft.com/powershell/module/exchange/set-mailboxsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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,7 +16,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -70,7 +70,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 @@ -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://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/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-MailboxServer.md b/exchange/exchange-ps/exchange/Set-MailboxServer.md index dc2d9df659..1e8ce40d3a 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxServer.md +++ b/exchange/exchange-ps/exchange/Set-MailboxServer.md @@ -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 ba1b02a956..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://learn.microsoft.com/powershell/module/exchange/set-mailboxspellingconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md index 7522bd58cc..97910b18d9 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md @@ -45,6 +45,7 @@ Set-MalwareFilterPolicy [-Identity] [-FileTypeAction ] [-FileTypes ] [-InternalSenderAdminAddress ] + [-IsPolicyOverrideApplied ] [-MakeDefault] [-QuarantineTag ] [-WhatIf] @@ -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. This is the default value. 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: 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, 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 621738598e..9589a6fc72 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md @@ -40,7 +40,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-malware-protection-about#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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md index 1a9dcca960..44d3d2ad77 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md @@ -22,8 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ### 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,6 +88,16 @@ 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. @@ -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://learn.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 c0af9f30c3..ee811f9b5f 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md +++ b/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md @@ -214,9 +214,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://learn.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. diff --git a/exchange/exchange-ps/exchange/Set-ManagementScope.md b/exchange/exchange-ps/exchange/Set-ManagementScope.md index a44d15b1da..7d84c230ae 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementScope.md +++ b/exchange/exchange-ps/exchange/Set-ManagementScope.md @@ -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-MessageClassification.md b/exchange/exchange-ps/exchange/Set-MessageClassification.md index 53f104100c..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://learn.microsoft.com/powershell/module/exchange/set-messageclassification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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 6389457632..17981b8c20 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Set-MigrationBatch.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Set-MigrationBatch [-Identity] + [-AddUsers] [-AllowIncrementalSyncs ] [-AllowUnknownColumnsInCsv ] [-ApproveSkippedItems] @@ -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. @@ -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 @@ -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-MigrationUser.md b/exchange/exchange-ps/exchange/Set-MigrationUser.md index cd9b025496..9a4d3dc9f8 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationUser.md +++ b/exchange/exchange-ps/exchange/Set-MigrationUser.md @@ -125,7 +125,7 @@ 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). @@ -232,7 +232,7 @@ 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). diff --git a/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md index fae32d830a..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://learn.microsoft.com/powershell/module/exchange/set-mobiledevicemailboxpolicy -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 title: Set-MobileDeviceMailboxPolicy schema: 2.0.0 author: chrisda @@ -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 8efc4dc96f..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://learn.microsoft.com/powershell/module/exchange/set-moverequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -45,6 +45,7 @@ Set-MoveRequest [-Identity] [-RequestExpiryInterval ] [-SkipMoving ] [-SkippedItemApprovalTime ] + [-SourceEndpoint ] [-StartAfter ] [-SuspendWhenReadyToComplete ] [-TargetDatabase ] @@ -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,7 +185,7 @@ 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). @@ -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 @@ -542,10 +543,28 @@ 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). @@ -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 7b6a526692..68c9290d33 100644 --- a/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md @@ -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://learn.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 b541366a8d..4d7ef423b7 100644 --- a/exchange/exchange-ps/exchange/Set-Notification.md +++ b/exchange/exchange-ps/exchange/Set-Notification.md @@ -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. @@ -66,7 +69,7 @@ This example configures the specified notification event to send notification em ## PARAMETERS ### -Identity -The Identity parameter specifies the notification event that you want to modify. 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. +The Identity parameter specifies the notification event that you want to modify. 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,AlternativeID,StartTime,Status,Type`. Typically, it only makes sense to modify notification recipients for events that haven't completed (if the event has completed, no more notification messages will be sent). diff --git a/exchange/exchange-ps/exchange/Set-OMEConfiguration.md b/exchange/exchange-ps/exchange/Set-OMEConfiguration.md index eb1fa70fa2..5e1079d1bc 100644 --- a/exchange/exchange-ps/exchange/Set-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-OMEConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-omeconfiguration -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-OMEConfiguration schema: 2.0.0 author: chrisda @@ -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://learn.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-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md index b69e8dcb35..b6bd614d26 100644 --- a/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md +++ b/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md @@ -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 5732baa025..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://learn.microsoft.com/powershell/module/exchange/set-onpremisesorganization -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-OnPremisesOrganization schema: 2.0.0 author: chrisda @@ -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 8a74f33232..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://learn.microsoft.com/powershell/module/exchange/set-organizationconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -23,19 +23,22 @@ For information about the parameter sets in the Syntax section below, see [Excha ### ShortenEventScopeParameter ``` Set-OrganizationConfig -ShortenEventScopeDefault + [-AcceptedDomainApprovedSendersEnabled ] + [-ActionableMessagesExtenalAccessTokenEnabled ] [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] - [-AllowPlusAddressInRecipients ] [-AppsForOfficeEnabled ] [-AsyncSendEnabled ] [-AuditDisabled ] [-AutodiscoverPartialDirSync ] [-AutoEnableArchiveMailbox ] [-AutoExpandingArchive] + [-AutomaticForcedReadReceiptEnabled ] [-BlockMoveMessagesForGroupFolders ] [-BookingsAddressEntryRestricted ] [-BookingsAuthEnabled ] + [-BookingsBlockedWordsEnabled ] [-BookingsCreationOfCustomQuestionsRestricted ] [-BookingsEnabled ] [-BookingsExposureOfStaffDetailsRestricted ] @@ -96,6 +99,7 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-FindTimeOnlineMeetingOptionDisabled ] [-FocusedInboxOn ] [-HierarchicalAddressBookRoot ] + [-HybridRSVPEnabled ] [-IPListBlocked ] [-IsAgendaMailEnabled ] [-IsGroupFoldersAndRulesEnabled ] @@ -110,6 +114,10 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-MaskClientIpInReceivedHeadersEnabled ] [-MatchSenderOrganizerProperties ] [-MessageHighlightsEnabled ] + [-MessageRecallAlertRecipientsEnabled ] + [-MessageRecallAlertRecipientsReadMessagesOnlyEnabled ] + [-MessageRecallEnabled ] + [-MessageRecallMaxRecallableAge ] [-MessageRemindersEnabled ] [-MobileAppEducationEnabled ] [-OAuth2ClientProfileEnabled ] @@ -121,6 +129,7 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-OutlookPayEnabled ] [-OutlookTextPredictionDisabled ] [-PerTenantSwitchToESTSEnabled ] + [-PostponeRoamingSignaturesUntilLater ] [-PreferredInternetCodePageForShiftJis ] [-PublicComputersDetectionEnabled ] [-PublicFoldersEnabled ] @@ -128,12 +137,14 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-ReadTrackingEnabled ] [-RecallReadMessagesEnabled ] [-RefreshSessionEnabled ] + [-RejectDirectSend ] [-RemotePublicFolderMailboxes ] [-RequiredCharsetCoverage ] [-SendFromAliasEnabled ] [-SharedDomainEmailAddressFlowEnabled ] [-SiteMailboxCreationURL ] [-SmtpActionableMessagesEnabled ] + [-TwoClickMailPreviewEnabled ] [-UnblockUnsafeSenderPromptEnabled ] [-VisibleMeetingUpdateProperties ] [-WebPushNotificationsDisabled ] @@ -145,10 +156,7 @@ Set-OrganizationConfig -ShortenEventScopeDefault ### AdfsAuthenticationParameter ``` -Set-OrganizationConfig [-AdfsAudienceUris ] - [-AdfsEncryptCertificateThumbprint ] - [-AdfsIssuer ] - [-AdfsSignCertificateThumbprints ] +Set-OrganizationConfig [-AdfsAudienceUris ] [-AdfsEncryptCertificateThumbprint ] [-AdfsIssuer ] [-AdfsSignCertificateThumbprints ] [-ACLableSyncedObjectEnabled ] [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] @@ -205,6 +213,7 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-MicrosoftExchangeRecipientPrimarySmtpAddress ] [-MicrosoftExchangeRecipientReplyRecipient ] [-MitigationsEnabled ] + [-OabShadowDistributionOldestFileAgeLimit ] [-OAuth2ClientProfileEnabled ] [-OrganizationSummary ] [-PreferredInternetCodePageForShiftJis ] @@ -212,9 +221,9 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-PublicFolderMailboxesLockedForNewConnections ] [-PublicFolderMailboxesMigrationComplete ] [-PublicFolderMigrationComplete ] + [-PublicFolderShowClientControl ] [-PublicFoldersEnabled ] [-PublicFoldersLockedForMigration ] - [-PublicFolderShowClientControl ] [-ReadTrackingEnabled ] [-RefreshSessionEnabled ] [-RemotePublicFolderMailboxes ] @@ -289,11 +298,11 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [-MicrosoftExchangeRecipientPrimarySmtpAddress ] [-MicrosoftExchangeRecipientReplyRecipient ] [-MitigationsEnabled ] + [-OabShadowDistributionOldestFileAgeLimit ] [-OAuth2ClientProfileEnabled ] [-OrganizationSummary ] [-PreferredInternetCodePageForShiftJis ] [-PublicComputersDetectionEnabled ] - [-PublicFolderContentReplicationDisabled ] [-PublicFolderMailboxesLockedForNewConnections ] [-PublicFolderMailboxesMigrationComplete ] [-PublicFolderMigrationComplete ] @@ -315,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 @@ -324,6 +460,7 @@ Set-OrganizationConfig [-ByteEncoderTypeFor7BitCharsets ] [-Confirm] [-CustomerFeedbackEnabled ] + [-DefaultAuthenticationPolicy ] [-DistributionGroupDefaultOU ] [-DistributionGroupNameBlockedWordsList ] [-DistributionGroupNamingPolicy ] @@ -348,6 +485,7 @@ Set-OrganizationConfig [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled ] [-MicrosoftExchangeRecipientPrimarySmtpAddress ] [-MicrosoftExchangeRecipientReplyRecipient ] + [-OabShadowDistributionOldestFileAgeLimit ] [-OrganizationSummary ] [-PermanentlyDeleteDisabled ] [-PreferredInternetCodePageForShiftJis ] @@ -362,6 +500,10 @@ Set-OrganizationConfig ``` ## DESCRIPTION + +> [!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 @@ -438,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. @@ -456,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: @@ -626,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 @@ -671,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 @@ -692,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 @@ -712,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 @@ -726,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 @@ -750,7 +910,7 @@ 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 @@ -761,14 +921,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockMoveMessagesForGroupFolders +### -AutomaticForcedReadReceiptEnabled This parameter is available only in the cloud-based service. -{{ Fill BlockMoveMessagesForGroupFolders Description }} +{{ Fill AutomaticForcedReadReceiptEnabled Description }} ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -779,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. @@ -789,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 @@ -810,7 +1000,7 @@ The BookingsAuthEnabled parameter specifies whether to enforce authentication to ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -828,7 +1018,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 @@ -849,7 +1039,7 @@ The BookingsCreationOfCustomQuestionsRestricted parameter specifies whether Book ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -872,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 @@ -893,7 +1083,7 @@ The BookingsExposureOfStaffDetailsRestricted parameter specifies whether the att ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -914,7 +1104,7 @@ The BookingsMembershipApprovalRequired parameter enables a membership approval r ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -932,7 +1122,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 @@ -950,7 +1140,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: String -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -968,7 +1158,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 @@ -986,7 +1176,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: String -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1004,7 +1194,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 @@ -1025,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 @@ -1046,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 @@ -1067,7 +1257,7 @@ The BookingsPhoneNumberEntryRestricted parameter specifies whether phone numbers ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1085,7 +1275,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 @@ -1103,7 +1293,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 @@ -1124,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 @@ -1168,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 @@ -1186,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 @@ -1207,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 @@ -1226,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 @@ -1243,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 @@ -1272,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 @@ -1293,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 @@ -1314,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 @@ -1328,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 @@ -1371,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 @@ -1413,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 @@ -1434,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 @@ -1494,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 @@ -1510,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 @@ -1538,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 @@ -1566,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 @@ -1584,7 +1774,7 @@ When you move folder contents between mailboxes, a copy of the original data is ```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 @@ -1612,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 @@ -1623,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. @@ -1633,7 +1856,7 @@ The DirectReportsGroupAutoCreationEnabled parameter specifies whether to enable ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1649,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://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 @@ -1762,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 @@ -1839,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 @@ -1878,7 +2101,7 @@ The EnableOutlookEvents parameter specifies whether Outlook or Outlook on the we ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1899,7 +2122,7 @@ The EndUserDLUpgradeFlowsDisabled parameter specifies whether to prevent users f ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1910,6 +2133,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EndUserMailNotificationForDelayedDelicensingEnabled +This parameter is available only in the cloud-based service. + +The EndUserMailNotificationForDelayedDelicensingEnabled parameter enables or disables periodic email warnings to affected users that have pending Exchange Online license removal requests on their mailboxes. Valid values are: + +- $true: Affected users receive periodic email notifications about losing access to their mailbox starting ~18 days after the Exchange Online license was removed. +- $false: Affected users don't receive periodic email notifications about losing access to their mailbox. This is the default value. + +The value of this parameter is meaningful on when the value of the DelayedDelicensingEnabled parameter is $true. + +Use the TenantAdminNotificationForDelayedDelicensingEnabled parameter to turn on weekly Service Health advisory notifications for admins about the number of Exchange Online delicensed users who are in the 30 day grace period during the specified 8 day interval. For more information about Service Health, see [How to check Microsoft 365 service health](https://learn.microsoft.com/microsoft-365/enterprise/view-service-health). + +```yaml +Type: Boolean +Parameter Sets: DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EwsAllowEntourage The EwsAllowEntourage parameter specifies whether to enable or disable Entourage 2008 to access Exchange Web Services (EWS) for the entire organization. The default value is $true. @@ -1933,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) @@ -2048,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 @@ -2066,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 @@ -2091,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 @@ -2107,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. @@ -2116,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 @@ -2141,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 @@ -2166,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 @@ -2191,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 @@ -2247,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. @@ -2286,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 @@ -2302,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 @@ -2370,13 +2641,20 @@ Accept wildcard characters: False ### -IsGroupFoldersAndRulesEnabled This parameter is available only in the cloud-based service. -{{ Fill IsGroupFoldersAndRulesEnabled Description }} +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 +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2388,17 +2666,33 @@ Accept wildcard characters: False ### -IsGroupMemberAllowedToEditContent This parameter is available only in the cloud-based service. -{{ Fill IsGroupMemberAllowedToEditContent Description }} +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 +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -2416,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 @@ -2435,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 @@ -2592,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 @@ -2610,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 @@ -2644,6 +2938,24 @@ This parameter is available only in the cloud-based service. {{ Fill MessageHighlightsEnabled Description }} +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallAlertRecipientsEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageRecallAlertRecipientsEnabled Description }} + ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter @@ -2657,6 +2969,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MessageRecallAlertRecipientsReadMessagesOnlyEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageRecallAlertRecipientsReadMessagesOnlyEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageRecallEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallMaxRecallableAge +{{ Fill MessageRecallMaxRecallableAge Description }} + +```yaml +Type: Microsoft.Exchange.Data.EnhancedTimeSpan +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MessageRemindersEnabled This parameter is available only in the cloud-based service. @@ -2667,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 @@ -2800,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 @@ -2811,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: @@ -2823,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 @@ -2847,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 @@ -2886,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 @@ -2916,7 +3298,7 @@ The Outlook for iOS and Android feature and services that are not FedRAMP compli ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2934,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 @@ -2952,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 @@ -2973,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 @@ -2991,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 @@ -3007,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. @@ -3032,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 @@ -3043,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. @@ -3154,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. @@ -3162,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 @@ -3174,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 @@ -3233,7 +3644,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: System.Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -3249,7 +3660,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 @@ -3260,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 @@ -3313,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 @@ -3343,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 @@ -3359,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 @@ -3378,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 @@ -3389,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. @@ -3412,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 @@ -3475,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 @@ -3516,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 @@ -3537,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 @@ -3555,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 @@ -3574,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 5d97f9c67a..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://learn.microsoft.com/powershell/module/exchange/set-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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 @@ -303,7 +303,7 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso 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 @@ -351,7 +351,7 @@ For more information, see [Cross-tenant mailbox migration](https://learn.microso 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 @@ -461,7 +461,7 @@ The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the 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 d39bf4815e..49cf493921 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationSegment.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationSegment.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-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/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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -27,9 +27,9 @@ Set-OrganizationSegment [-Identity] ``` ## DESCRIPTION -Segments are defined by using certain [attributes](https://learn.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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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,7 +66,7 @@ Accept wildcard characters: False 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://learn.microsoft.com/microsoft-365/compliance/information-barriers-attributes). +- 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). @@ -96,8 +96,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Attributes for information barrier policies](https://learn.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://learn.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) [New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Set-OutlookProvider.md b/exchange/exchange-ps/exchange/Set-OutlookProvider.md index 33490f7e4c..3d9413c338 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookProvider.md +++ b/exchange/exchange-ps/exchange/Set-OutlookProvider.md @@ -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 90346e772c..ffb11aae40 100644 --- a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Set-OwaMailboxPolicy [-Identity] + [-AccountTransferEnabled ] [-ActionForUnknownFileAndMIMETypes ] [-ActiveSyncIntegrationEnabled ] [-AdditionalAccountsEnabled ] @@ -30,10 +31,13 @@ Set-OwaMailboxPolicy [-Identity] [-AllowCopyContactsToDeviceAddressBook ] [-AllowedFileTypes ] [-AllowedMimeTypes ] + [-AllowedOrganizationAccountDomains ] [-AllowOfflineOn ] + [-BizBarEnabled ] [-BlockedFileTypes ] [-BlockedMimeTypes ] [-BookingsMailboxCreationEnabled ] + [-BookingsMailboxDomain ] [-BoxAttachmentsEnabled ] [-CalendarEnabled ] [-ChangePasswordEnabled ] @@ -51,6 +55,7 @@ Set-OwaMailboxPolicy [-Identity] [-DisplayPhotosEnabled ] [-DomainController ] [-DropboxAttachmentsEnabled ] + [-EmptyStateEnabled ] [-ExplicitLogonEnabled ] [-ExternalImageProxyEnabled ] [-ExternalSPMySiteHostURL ] @@ -66,6 +71,7 @@ Set-OwaMailboxPolicy [-Identity] [-GlobalAddressListEnabled ] [-GoogleDriveAttachmentsEnabled ] [-GroupCreationEnabled ] + [-HideClassicOutlookToggleOut ] [-InstantMessagingEnabled ] [-InstantMessagingType ] [-InterestingCalendarsEnabled ] @@ -79,16 +85,22 @@ Set-OwaMailboxPolicy [-Identity] [-LocalEventsEnabled ] [-LogonAndErrorLanguage ] [-MessagePreviewsDisabled ] + [-MonthlyUpdatesEnabled ] [-Name ] [-NotesEnabled ] [-NpsSurveysEnabled ] - [-OrganizationEnabled ] + [-OfflineEnabledWeb ] + [-OfflineEnabledWin ] [-OneDriveAttachmentsEnabled ] [-OneWinNativeOutlookEnabled ] [-OnSendAddinsEnabled ] + [-OrganizationEnabled ] [-OutboundCharset ] [-OutlookBetaToggleEnabled ] - [] + [-OutlookDataFile ] + [-OutlookNewslettersAccessLevel ] + [-OutlookNewslettersReactions ] + [-OutlookNewslettersShowMore ] [-OWALightEnabled ] [-OWAMiniEnabled ] [-PersonalAccountCalendarsEnabled ] @@ -150,7 +162,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -206,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: @@ -269,7 +299,9 @@ Accept wildcard characters: False ### -AdditionalAccountsEnabled This parameter is available only in the cloud-based service. -{{ Fill AdditionalAccountsEnabled Description }} +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 @@ -379,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. @@ -403,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: @@ -482,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. @@ -543,9 +629,14 @@ Accept wildcard characters: False ``` ### -ChangeSettingsAccountEnabled -This parameter is functional only in the cloud-based service. +This parameter is available only in the cloud-based service. -{{ Fill ChangeSettingsAccountEnabled Description }} +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 @@ -582,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 @@ -822,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. @@ -867,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 @@ -1146,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: @@ -1208,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 @@ -1265,7 +1395,12 @@ Accept wildcard characters: False ### -ItemsToOtherAccountsEnabled This parameter is available only in the cloud-based service. -{{ Fill ItemsToOtherAccountsEnabled Description }} +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 @@ -1397,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. @@ -1453,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. @@ -1567,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 @@ -1631,7 +1926,10 @@ Accept wildcard characters: False ### -PersonalAccountsEnabled This parameter is available only in the cloud-based service. -{{ Fill PersonalAccountsEnabled Description }} +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 @@ -1829,7 +2127,7 @@ 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 365 Defender portal as described in [User reported message settings](https://learn.microsoft.com/microsoft-365/security/office-365-security/submissions-user-reported-messages-files-custom-mailbox). +**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: @@ -1933,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) diff --git a/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md index 1480d1435c..14358aa512 100644 --- a/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md @@ -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 diff --git a/exchange/exchange-ps/exchange/Set-PartnerApplication.md b/exchange/exchange-ps/exchange/Set-PartnerApplication.md index 244b476684..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://learn.microsoft.com/powershell/module/exchange/set-partnerapplication -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 title: Set-PartnerApplication schema: 2.0.0 author: chrisda @@ -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-PerimeterConfig.md b/exchange/exchange-ps/exchange/Set-PerimeterConfig.md index e696e1de53..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://learn.microsoft.com/powershell/module/exchange/set-perimeterconfig -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-PerimeterConfig schema: 2.0.0 author: chrisda @@ -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 d02b55617d..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://learn.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://learn.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://learn.microsoft.com/microsoft-365/security/office-365-security/anti-spoofing-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://learn.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 8100c1d68d..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://learn.microsoft.com/powershell/module/exchange/set-phishsimoverridepolicy -applicable: Security & Compliance +applicable: Exchange Online title: Set-PhishSimOverridePolicy schema: 2.0.0 author: chrisda @@ -12,9 +12,9 @@ ms.reviewer: # Set-PhishSimOverridePolicy ## 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). +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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 f7f5b65c69..aeffd3882a 100644 --- a/exchange/exchange-ps/exchange/Set-Place.md +++ b/exchange/exchange-ps/exchange/Set-Place.md @@ -16,9 +16,9 @@ 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. -**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 [Updates for version 3.0.0 (the EXO V3 module)](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#updates-for-version-300-the-exo-v3-module). +**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). @@ -32,7 +32,6 @@ Set-Place [-Identity] [-City ] [-Confirm] [-CountryOrRegion ] - [-Desks ] [-DisplayDeviceName ] [-Floor ] [-FloorLabel ] @@ -40,9 +39,10 @@ Set-Place [-Identity] [-IsWheelChairAccessible ] [-Label ] [-MTREnabled ] + [-ParentId ] + [-ParentType ] [-Phone ] [-PostalCode ] - [-SpaceType ] [-State ] [-Street ] [-Tags ] @@ -197,22 +197,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Desks -{{ Fill Desks Description }} - -```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 -``` - ### -DisplayDeviceName The DisplayDeviceName parameter specifies the name of the display device in the room. If the value contains spaces, enclose the value in quotation marks ("). @@ -342,8 +326,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Phone -The Phone parameter specifies the room's telephone number. +### -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 @@ -358,11 +346,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PostalCode -The PostalCode parameter specifies the room's postal code. +### -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: String +Type: Microsoft.Exchange.Management.RecipientTasks.SetPlaceParentType Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -374,20 +369,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpaceType -**Note**: Currently, this parameter is not available in all organizations. +### -Phone +The Phone parameter specifies the room's telephone number. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online -The SpaceType parameter specifies the type of space. Valid values are: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -- CustomerSpace -- WorkArea -- Custom +### -PostalCode +The PostalCode parameter specifies the room's postal code. ```yaml Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Online + Required: False Position: Named Default value: None diff --git a/exchange/exchange-ps/exchange/Set-PolicyConfig.md b/exchange/exchange-ps/exchange/Set-PolicyConfig.md index 97a3f3fd41..6455c497f6 100644 --- a/exchange/exchange-ps/exchange/Set-PolicyConfig.md +++ b/exchange/exchange-ps/exchange/Set-PolicyConfig.md @@ -28,24 +28,35 @@ Set-PolicyConfig [[-Identity] ] [-Confirm] [-DlpAppGroups ] [-DlpAppGroupsPsws ] + [-DlpExtensionGroups ] + [-DlpNetworkShareGroups ] + [-DlpPrinterGroups ] + [-DlpRemovableMediaGroups ] [-DocumentIsUnsupportedSeverity ] + [-EnableAdvancedRuleBuilder ] [-EnableLabelCoauth ] [-EnableSpoAipMigration ] [-EndpointDlpGlobalSettings ] [-EndpointDlpGlobalSettingsPsws ] [-ExtendTeamsDlpPoliciesToSharePointOneDrive ] + [-InformationBarrierMode ] + [-InformationBarrierPeopleSearchRestriction ] + [-IsDlpSimulationOptedIn ] [-OnPremisesWorkload ] [-ProcessingLimitExceededSeverity ] [-PurviewLabelConsent ] + [-ReservedForFutureUse ] [-RetentionForwardCrawl ] [-RuleErrorAction ] [-SenderAddressLocation ] + [-SiteGroups ] + [-SiteGroupsPsws ] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 +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 @@ -174,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 }} @@ -191,6 +266,22 @@ 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 The EnableLabelCoauth parameter enables or disables co-authoring support in Office desktop apps for the entire organization. Valid value are: @@ -285,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 @@ -300,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 }} @@ -350,6 +497,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ReservedForFutureUse +{{ Fill ReservedForFutureUse Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RetentionForwardCrawl {{ Fill RetentionForwardCrawl Description }} @@ -407,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-ProtectionAlert.md b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md index 59ad7551bc..c1875d6ea6 100644 --- a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md @@ -53,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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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,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 @@ -388,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 @@ -442,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://learn.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. diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md b/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md index a4a4963fa6..124bd14378 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md +++ b/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md @@ -14,7 +14,9 @@ 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. + +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). @@ -22,18 +24,19 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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,7 +223,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/Set-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md index a77fa2acc5..796d65b9a1 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md @@ -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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-QuarantineTag [-Identity] +Set-QuarantinePolicy [-Identity] [-AdminNotificationFrequencyInDays ] [-AdminNotificationLanguage ] [-AdminNotificationsEnabled ] @@ -31,20 +31,25 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 @@ -398,7 +492,7 @@ The OrganizationBrandingEnabled parameter enables or disables organization brand - $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 ac08f0de6e..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://learn.microsoft.com/powershell/module/exchange/set-rmstemplate -applicable: Exchange Online +applicable: Exchange Online, Exchange Online Protection title: Set-RMSTemplate schema: 2.0.0 author: chrisda @@ -14,7 +14,10 @@ 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). + +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). @@ -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 4c58164807..0243479192 100644 --- a/exchange/exchange-ps/exchange/Set-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/Set-ReceiveConnector.md @@ -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. diff --git a/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md b/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md index 2de72b0b8e..b3552f8231 100644 --- a/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md +++ b/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 cf02eeb232..8f7c3965a5 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/Set-RemoteDomain.md @@ -43,6 +43,7 @@ Set-RemoteDomain [-Identity] [-NonMimeCharacterSet ] [-PreferredInternetCodePageForShiftJis ] [-RequiredCharsetCoverage ] + [-SmtpDaneMandatoryModeEnabled ] [-TargetDeliveryDomain ] [-TNEFEnabled ] [-TrustedMailInboundEnabled ] @@ -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 7dd9b4e9e2..6850e91830 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Set-RemoteMailbox.md @@ -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://learn.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: @@ -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 index b1cef39baa..9e9b525a46 100644 --- a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md @@ -60,6 +60,7 @@ Set-ReportSubmissionPolicy [-Identity] [-PreSubmitMessageTitleForNotJunk ] [-PreSubmitMessageTitleForPhishing ] [-ReportChatMessageEnabled ] + [-ReportChatMessageToCustomizedAddressEnabled ] [-ReportJunkAddresses ] [-ReportJunkToCustomizedAddress ] [-ReportNotJunkAddresses ] @@ -74,11 +75,11 @@ Set-ReportSubmissionPolicy [-Identity] ``` ## DESCRIPTION -The report submission policy controls most of the settings for user submissions in the Microsoft 365 Defender portal at . +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 365 Defender portal, the same email address is also set in the following parameters in the \*-ReportSubmissionPolicy cmdlets: +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. @@ -96,7 +97,7 @@ Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReport Get-ReportSubmissionRule | Remove-ReportSubmissionRule ``` -This example turns on the Microsoft integrated reporting experience, uses Microsoft reporting tools in Outlook, but allows users to report messages to Microsoft only. The reporting mailbox is not used. +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**: @@ -112,7 +113,7 @@ Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReport New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub ``` -This example turns on the Microsoft integrated reporting experience, uses Microsoft reporting tools in Outlook, allows users to report messages to Microsoft, and sends reported messages to the specified reporting mailbox. +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: @@ -128,7 +129,7 @@ Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReport New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub ``` -This example turns on the Microsoft integrated reporting experience, uses Microsoft reporting tools in Outlook, and sends reported messages to the specified reporting mailbox only (users can't report messages to Microsoft). +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: @@ -144,7 +145,7 @@ Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReport New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub ``` -This example turns on the Microsoft integrated reporting experience, but uses third-party reporting tools in Outlook to send reported messages to the specified reporting mailbox in Exchange Online. +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: @@ -158,7 +159,7 @@ Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReport 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 365 Defender portal. +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. @@ -205,7 +206,7 @@ The DisableQuarantineReportingOption parameter allows or prevents users from rep - $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 the Microsoft integrated reporting experience is enabled as described in the EnableReportToMicrosoft parameter. +This parameter is meaningful only reporting in Outlook is enabled as described in the EnableReportToMicrosoft parameter. ```yaml Type: Boolean @@ -279,7 +280,7 @@ The EnableOrganizationBranding parameter specifies whether to show the company l - $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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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: Boolean @@ -297,15 +298,16 @@ 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 the Microsoft integrated reporting experience. The following configurations are possible: +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. +- **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 the Microsoft integrated reporting experience. The following configurations are possible: +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. -- **The Microsoft integrated reporting experience 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 365 Defender portal**: The EnableThirdPartyAddress, ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. +- **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 @@ -321,10 +323,14 @@ 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: +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. -- $true: The Microsoft integrated reporting experience 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. +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 @@ -342,14 +348,14 @@ 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. +- $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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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: Boolean @@ -367,7 +373,7 @@ 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. +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. @@ -389,7 +395,7 @@ 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. +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. @@ -413,7 +419,7 @@ The NotificationFooterMessage parameter specifies the custom footer text to use 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. +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 @@ -431,10 +437,10 @@ 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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: +Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -529,7 +535,7 @@ 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. +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. @@ -553,7 +559,7 @@ The PostSubmitMessage parameter specifies the custom pop-up message text to use 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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 @@ -640,7 +646,7 @@ The PostSubmitMessage parameter parameter specifies the custom pop-up message ti 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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 @@ -708,7 +714,7 @@ The PreSubmitMessage parameter specifies the custom pop-up message text to use i 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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 @@ -795,7 +801,7 @@ The PreSubmitMessage parameter parameter specifies the custom pop-up message tit 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 the Microsoft integrated reporting experience is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft 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 @@ -874,10 +880,26 @@ 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 the Microsoft integrated reporting experience using Microsoft or third-party reporting tools in Outlook. +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. @@ -897,7 +919,7 @@ 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 the Microsoft integrated reporting experience. Valid values are: +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. @@ -918,9 +940,9 @@ 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. +**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 the Microsoft integrated reporting experience using Microsoft or third-party reporting tools in Outlook. +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. @@ -940,7 +962,7 @@ 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 the Microsoft integrated reporting experience. Valid values are: +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. @@ -963,7 +985,7 @@ 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 the Microsoft integrated reporting experience using Microsoft or third-party reporting tools in Outlook. +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. @@ -983,7 +1005,7 @@ 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 the Microsoft integrated reporting experience. Valid values are: +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. @@ -1006,11 +1028,11 @@ 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 the Microsoft integrated reporting experience. +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 the Microsoft integrated reporting experience in favor of a third-party product, see the EnableThirdPartyAddress 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 diff --git a/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md index 389199af10..88878ff4a1 100644 --- a/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md +++ b/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md @@ -34,7 +34,7 @@ Set-ReportSubmissionRule [-Identity] ## 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 365 Defender portal at , the same email address is also set in the *\-ReportSubmissionPolicy cmdlets: +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. @@ -140,12 +140,12 @@ 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 the Microsoft integrated reporting experience is enabled, and user reported messages are sent to a reporting mailbox as configured in the \*-ReportSubmissionPolicy cmdlets (either of the following scenarios): +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 365 Defender portal, the following parameters in the *\-ReportSubmissionPolicy cmdlets are set to the same value: +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. diff --git a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md index 38c63b42bd..c309e308bb 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md @@ -22,15 +22,6 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX -### RetryDistribution -``` -Set-RetentionCompliancePolicy [-Identity] - [-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to 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,6 +753,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 +``` + ### -PolicyTemplateInfo This parameter is reserved for internal Microsoft use. @@ -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 530bf99f6d..3a544e128a 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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,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://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/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. @@ -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 1910b4bde5..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://learn.microsoft.com/powershell/module/exchange/set-retentionpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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 @@ -227,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 172938f197..f4d7334536 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md +++ b/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md @@ -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-RoleGroup.md b/exchange/exchange-ps/exchange/Set-RoleGroup.md index d09c1b266b..b0c9fd04a3 100644 --- a/exchange/exchange-ps/exchange/Set-RoleGroup.md +++ b/exchange/exchange-ps/exchange/Set-RoleGroup.md @@ -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" ``` diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md index acd4a120a2..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://learn.microsoft.com/powershell/module/exchange/set-safeattachmentpolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-SafeAttachmentPolicy schema: 2.0.0 author: chrisda @@ -23,7 +23,6 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Set-SafeAttachmentPolicy [-Identity] [-Action ] - [-ActionOnError ] [-AdminDisplayName ] [-Confirm] [-Enable ] @@ -35,7 +34,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-attachments-about). +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. @@ -45,10 +44,10 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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. This action will be deprecated. For more information, see [MC424901](https://admin.microsoft.com/AdminPortal/Home#/MessageCenter/:/messages/MC424901). -- 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/microsoft-365/security/office-365-security/safe-attachments-about#dynamic-delivery-in-safe-attachments-policies). +- 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,18 +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. -**Note**: Redirection will soon be available only for the Allow action. For more information, see [MC424899](https://admin.microsoft.com/AdminPortal/Home?#/MessageCenter/:/messages/MC424899). - ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -220,15 +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. -**Note**: Redirection will soon be available only for the Allow action. For more information, see [MC424899](https://admin.microsoft.com/AdminPortal/Home?#/MessageCenter/:/messages/MC424899). +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,13 +221,11 @@ 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. -**Note**: Redirection will soon be available only for the Allow action. For more information, see [MC424899](https://admin.microsoft.com/AdminPortal/Home?#/MessageCenter/:/messages/MC424899). - ```yaml 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 46172d4b22..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://learn.microsoft.com/powershell/module/exchange/set-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -38,12 +38,12 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-attachments-about). +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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 df99261648..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://learn.microsoft.com/powershell/module/exchange/set-safelinkspolicy -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-SafeLinksPolicy schema: 2.0.0 author: chrisda @@ -26,7 +26,7 @@ Set-SafeLinksPolicy [-Identity] [-AllowClickThrough ] [-Confirm] [-CustomNotificationText ] - [-DeliverMessageAfterScan + [-DeliverMessageAfterScan ] [-DisableUrlRewrite ] [-DoNotRewriteUrls ] [-EnableForInternalSenders ] @@ -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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-links-about#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 @@ -228,13 +232,13 @@ Accept wildcard characters: False 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://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. +- $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 02bd689daa..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://learn.microsoft.com/powershell/module/exchange/set-safelinksrule -applicable: Exchange Online, Exchange Online Protection +applicable: Exchange Online title: Set-SafeLinksRule schema: 2.0.0 author: chrisda @@ -41,7 +41,7 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/safe-links-about#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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 81cff6c808..4288a07794 100644 --- a/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md +++ b/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md @@ -31,7 +31,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md index 9f52a72bfa..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://learn.microsoft.com/powershell/module/exchange/set-secopsoverridepolicy -applicable: Security & Compliance +applicable: Exchange Online title: Set-SecOpsOverridePolicy schema: 2.0.0 author: chrisda @@ -12,9 +12,9 @@ ms.reviewer: # Set-SecOpsOverridePolicy ## 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). +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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.microsoft.com/microsoft-365/security/office-365-security/scc-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter 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 a87c6b0fa7..a8e6726d37 100644 --- a/exchange/exchange-ps/exchange/Set-SendConnector.md +++ b/exchange/exchange-ps/exchange/Set-SendConnector.md @@ -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-ServerComponentState.md b/exchange/exchange-ps/exchange/Set-ServerComponentState.md index 94f4d5e415..11c76cf3c6 100644 --- a/exchange/exchange-ps/exchange/Set-ServerComponentState.md +++ b/exchange/exchange-ps/exchange/Set-ServerComponentState.md @@ -38,11 +38,26 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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-ServicePrincipal.md b/exchange/exchange-ps/exchange/Set-ServicePrincipal.md index cc06aaf022..78b5a30bc0 100644 --- a/exchange/exchange-ps/exchange/Set-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/Set-ServicePrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/set-serviceprincipal -applicable: Exchange Online +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Set-ServicePrincipal schema: 2.0.0 author: chrisda @@ -29,7 +29,7 @@ Set-ServicePrincipal [-Identity] ``` ## DESCRIPTION -You can use this cmdlet to change the DisplayName only. If AppId/ServiceId is wrong, delete the service principal and create a new one. +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). @@ -51,13 +51,13 @@ The Identity parameter specifies the service principal that you want to modify. - 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: True Position: Named @@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -92,7 +92,7 @@ The DisplayName parameter specifies the friendly name of the service principal. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -108,7 +108,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, Security & Compliance, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Set-SharingPolicy.md b/exchange/exchange-ps/exchange/Set-SharingPolicy.md index ebd73e7278..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://learn.microsoft.com/powershell/module/exchange/set-sharingpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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-SmimeConfig.md b/exchange/exchange-ps/exchange/Set-SmimeConfig.md index 9c7b0865ae..3b0f0fe2bb 100644 --- a/exchange/exchange-ps/exchange/Set-SmimeConfig.md +++ b/exchange/exchange-ps/exchange/Set-SmimeConfig.md @@ -40,6 +40,7 @@ Set-SmimeConfig [[-Identity] ] [-OWAIncludeCertificateChainAndRootCertificate ] [-OWAIncludeCertificateChainWithoutRootCertificate ] [-OWAIncludeSMIMECapabilitiesInMessage ] + [-OWANoSignOnReply ] [-OWAOnlyUseSmartCard ] [-OWASenderCertificateAttributesToDisplay ] [-OWASignedEmailCertificateInclusion ] @@ -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 6b23560802..ac5377657b 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 4246d3372b..3b3c0210d9 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md @@ -22,20 +22,33 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 428d17d7d2..184a02c1af 100644 --- a/exchange/exchange-ps/exchange/Set-SweepRule.md +++ b/exchange/exchange-ps/exchange/Set-SweepRule.md @@ -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 f35c074132..0cb1bfebec 100644 --- a/exchange/exchange-ps/exchange/Set-SystemMessage.md +++ b/exchange/exchange-ps/exchange/Set-SystemMessage.md @@ -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 4a0f90cc3e..843a7d4d31 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -30,6 +30,7 @@ Set-TenantAllowBlockListItems -Ids -ListType [-NoExpiration] [-Notes ] [-OutputJson] + [-RemoveAfter ] [] ``` @@ -43,11 +44,12 @@ 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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +In most cases, you can't modify the sender, URL, file, or IP address values after you create the entry. The only exception is URL allow entries for phishing simulations (ListType = URL, ListSubType = AdvancedDelivery). For more information about allowing URLs for phishing simulations, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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. @@ -157,15 +165,13 @@ Accept wildcard characters: False ``` ### -Allow -This parameter is available only in Exchange Online PowerShell. - The Allow switch specifies that you're modifying an allow entry. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -198,7 +204,7 @@ To specify a date/time value for this parameter, use either of the following opt - Specify the date/time value in UTC: For example, `"2021-05-06 14:30:00z"`. - Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2020 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). -You can't use this parameter with the NoExpiration switch. +You can't use this parameter with the NoExpiration or RemoveAfter parameters. ```yaml Type: DateTime @@ -214,18 +220,16 @@ Accept wildcard characters: False ``` ### -ListSubType -This parameter is available only in Exchange Online PowerShell. - 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://learn.microsoft.com/microsoft-365/security/office-365-security/skip-filtering-phising-simulations-sec-ops-mailboxes). +- 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 @@ -268,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 a4e1f63b9a..e410aa39ca 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md @@ -37,6 +37,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell Get-TenantAllowBlockListSpoofItems | Format-Table SpoofedUser,SendingInfrastructure,SpoofType,Action,Identity + Set-TenantAllowBlockListSpoofItems -Identity Default -Action Block -Ids 375e76f1-eefb-1626-c8bc-5efefd057488,f8cb0908-8533-1156-ce7b-9aebd685b0eb ``` @@ -44,8 +45,7 @@ This example bocks the specified spoof pairs. You get the Ids parameter values f ### Example 2 ```powershell -(Get-TenantAllowBlockListSpoofItems -SpoofType External | Select-Object -Property Identity).Identity | Remove-TenantAllowBlockListSpoofItems -Identity -Default +(Get-TenantAllowBlockListSpoofItems -SpoofType External | Select-Object -Property Identity).Identity | Remove-TenantAllowBlockListSpoofItems -Identity Default ``` This example removes all external spoof pairs from the Tenant Allow/Block List. diff --git a/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md b/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md index a04b9efcbb..57563a2af1 100644 --- a/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md +++ b/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md @@ -104,7 +104,7 @@ Accept wildcard characters: False ``` ### -CountryRegionId -The CountryRegionId parameter specifies the country that your mobile phone is registered in. Although this parameter accepts any valid ISO 3166-1 two-letter country code value (for example, AU for Australia), the following values correspond to the country selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): +The CountryRegionId parameter specifies the country/region that your mobile phone is registered in. Although this parameter accepts any valid ISO 3166-1 two-letter country code value (for example, AU for Australia), the following values correspond to the country/region selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): - US - CA @@ -165,7 +165,7 @@ Accept wildcard characters: False ``` ### -MobileOperatorId -The MobileOperatorId parameter specifies the mobile operator (carrier) for your phone. Although this parameter accepts any random number, the following values correspond to the country and mobile operator selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): +The MobileOperatorId parameter specifies the mobile operator (carrier) for your phone. Although this parameter accepts any random number, the following values correspond to the country/region and mobile operator selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): United States: diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md index 593a44302d..aec6333325 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md @@ -173,7 +173,7 @@ Set-ThrottlingPolicy [-Identity] ## DESCRIPTION Throttling policy settings are stored in Active Directory. -By default, there is one default user throttling policy named GlobalThrottlingPolicy with a throttling scope of Global. Exchange Setup creates this policy as part of the Client Access server role. You shouldn't replace, re-create, or remove the existing default throttling policy. However, you can edit any additional throttling policies with the scope of Organization or Regular if you want to change your user throttling settings. You can create polices with the scope of Organization or Regular using the New-ThrottlingPolicy cmdlet. +By default, there is one default user throttling policy named GlobalThrottlingPolicy with a throttling scope of Global. Exchange Setup creates this policy as part of the Client Access server role. You shouldn't replace, re-create, or remove the existing default throttling policy. However, you can edit any additional throttling policies with the scope of Organization or Regular if you want to change your user throttling settings. You can create policies with the scope of Organization or Regular using the New-ThrottlingPolicy cmdlet. For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). @@ -184,6 +184,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell $a = Get-ThrottlingPolicy RemoteSiteUserPolicy + $a | Set-ThrottlingPolicy -EwsMaxConcurrency 4 ``` diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index 3f25322e85..7179fe0d72 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -14,9 +14,11 @@ 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. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +**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). ## SYNTAX @@ -36,7 +38,7 @@ In data center deployments, the object referred to by the Identity and Throttlin 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://learn.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-TransportConfig.md b/exchange/exchange-ps/exchange/Set-TransportConfig.md index 453b5f41d3..57473281ff 100644 --- a/exchange/exchange-ps/exchange/Set-TransportConfig.md +++ b/exchange/exchange-ps/exchange/Set-TransportConfig.md @@ -61,6 +61,8 @@ Set-TransportConfig [[-Identity] ] [-MaxRetriesForLocalSiteShadow ] [-MaxRetriesForRemoteSiteShadow ] [-MaxSendSize ] + [-MessageExpiration ] + [-PreventDuplicateJournalingEnabled ] [-QueueDiagnosticsAggregationInterval ] [-RejectMessageOnShadowFailure ] [-ReplyAllStormBlockDurationHours ] @@ -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. @@ -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 5739eba7f9..d5e0d7dd39 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -16,7 +16,11 @@ 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**: + +- 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). @@ -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,18 +664,23 @@ 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: 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. This is the default value.
• 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. +- 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. - In Exchange Online, we recommend using the value Reject for this parameter. - ```yaml Type: DisclaimerFallbackAction Parameter Sets: (All) @@ -692,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: @@ -717,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 @@ -782,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 ("). @@ -808,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. @@ -830,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) @@ -850,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) @@ -873,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. @@ -896,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://learn.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 @@ -921,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. @@ -945,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"`. @@ -965,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: @@ -990,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: @@ -1061,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: @@ -1090,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: @@ -1183,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. @@ -1278,6 +1319,8 @@ Accept wildcard characters: False ``` ### -DlpPolicy +**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 @@ -1314,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. @@ -1366,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: @@ -1389,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: @@ -1422,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: @@ -1455,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. @@ -1481,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. @@ -1507,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: @@ -1540,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: @@ -1573,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: @@ -1606,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: @@ -1639,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. @@ -1661,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) @@ -1681,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) @@ -1704,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. @@ -1727,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://learn.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 @@ -1752,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. @@ -1776,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"`. @@ -1796,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: @@ -1821,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: @@ -1860,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. @@ -1890,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: @@ -1919,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: @@ -1948,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. @@ -1970,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: @@ -2001,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. @@ -2023,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. @@ -2031,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) @@ -2045,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: @@ -2076,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 @@ -2099,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. @@ -2125,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: @@ -2148,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. + +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: @@ -2171,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. @@ -2191,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. @@ -2215,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. @@ -2235,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. @@ -2257,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: @@ -2288,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: @@ -2313,9 +2364,11 @@ 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. @@ -2337,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. @@ -2367,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). @@ -2397,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. @@ -2453,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. @@ -2507,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. @@ -2527,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"`. @@ -2549,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[] @@ -2589,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 parameter doesn't include the ExceptIf prefix. -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -This condition is available on Mailbox servers and Edge Transport servers. This condition is not available or functional in the cloud-based service due to how the service filtering stack works. +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. The ExceptIfSCLOver parameter specifies an exception that looks for the SCL value of messages. Valid values are: @@ -2616,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. @@ -2672,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. @@ -2726,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). @@ -2768,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: @@ -2780,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) @@ -2794,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: @@ -2817,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: @@ -2846,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: @@ -2873,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 @@ -2898,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[] @@ -2920,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. @@ -2940,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[] @@ -2962,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. @@ -2982,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: @@ -3006,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 @@ -3028,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: @@ -3087,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) @@ -3103,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: @@ -3138,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 @@ -3157,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: @@ -3168,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 @@ -3186,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: @@ -3199,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) @@ -3215,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. @@ -3241,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: @@ -3262,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: @@ -3373,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. @@ -3383,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. @@ -3416,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: @@ -3467,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: @@ -3498,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: @@ -3521,9 +3582,11 @@ 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. @@ -3579,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). @@ -3609,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 @@ -3629,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: @@ -3654,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: @@ -3699,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: @@ -3786,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) @@ -3802,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. @@ -3858,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. @@ -3912,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. @@ -3932,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"`. @@ -3956,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 @@ -3975,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[] @@ -4044,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. @@ -4070,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". @@ -4164,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 @@ -4206,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: @@ -4248,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 @@ -4265,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: @@ -4294,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. @@ -4350,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. @@ -4404,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 @@ -4432,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). @@ -4474,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: @@ -4484,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) @@ -4500,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: @@ -4523,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: @@ -4552,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: @@ -4583,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 @@ -4608,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: @@ -4767,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[] @@ -4809,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[] @@ -4863,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 9832122fc3..f9958ab658 100644 --- a/exchange/exchange-ps/exchange/Set-TransportServer.md +++ b/exchange/exchange-ps/exchange/Set-TransportServer.md @@ -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 58fdb299b8..c6c5a3fe45 100644 --- a/exchange/exchange-ps/exchange/Set-TransportService.md +++ b/exchange/exchange-ps/exchange/Set-TransportService.md @@ -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 dca8ea11b5..c224bb9dc4 100644 --- a/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md +++ b/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md @@ -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-UMDialPlan.md b/exchange/exchange-ps/exchange/Set-UMDialPlan.md index 79ff7a318c..0255771570 100644 --- a/exchange/exchange-ps/exchange/Set-UMDialPlan.md +++ b/exchange/exchange-ps/exchange/Set-UMDialPlan.md @@ -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-UMMailbox.md b/exchange/exchange-ps/exchange/Set-UMMailbox.md index ea3922e94b..7e179f4bc5 100644 --- a/exchange/exchange-ps/exchange/Set-UMMailbox.md +++ b/exchange/exchange-ps/exchange/Set-UMMailbox.md @@ -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 diff --git a/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md index a491790c21..789aabc713 100644 --- a/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md @@ -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-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md index b59f5b68d2..b54bb64a99 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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://learn.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://learn.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 @@ -904,7 +902,7 @@ Valid input for this parameter is a supported culture code value from the Micros 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,8 +1165,6 @@ 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. **Note**: In the output of the Get-UnifiedGroup cmdlet, this property is named SensitivityLabel, not SensitivityLabelId. @@ -1179,7 +1173,7 @@ The SensitivityLabelId parameter specifies the GUID value of the sensitivity lab Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1202,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 @@ -1217,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. @@ -1225,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 @@ -1241,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 41191723a4..09606906d6 100644 --- a/exchange/exchange-ps/exchange/Set-User.md +++ b/exchange/exchange-ps/exchange/Set-User.md @@ -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 ] @@ -292,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 @@ -402,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 @@ -445,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. @@ -573,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. @@ -662,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. @@ -681,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 @@ -809,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 @@ -833,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 @@ -915,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) @@ -1083,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 diff --git a/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md b/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md index e904a03395..d036882c11 100644 --- a/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md @@ -27,13 +27,18 @@ Set-UserBriefingConfig -Identity -Enabled ``` ## 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://learn.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-UserPhoto.md b/exchange/exchange-ps/exchange/Set-UserPhoto.md index 7eddc5a04d..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://learn.microsoft.com/powershell/module/exchange/set-userphoto -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-UserPhoto schema: 2.0.0 author: chrisda @@ -12,9 +12,11 @@ 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. + +**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). @@ -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,19 +87,17 @@ 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://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguserphoto) and [Set-MgUserPhotoContent](https://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 c8d1077c32..d794753e4e 100644 --- a/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md +++ b/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md @@ -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://learn.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-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md index 1842f065f2..30872ecd30 100644 --- a/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md @@ -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 0ab381e397..ddcb34db75 100644 --- a/exchange/exchange-ps/exchange/Start-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Start-ComplianceSearch.md @@ -34,7 +34,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-HistoricalSearch.md b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md index 663b1dc9b9..598f93159b 100644 --- a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md +++ b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md @@ -22,7 +22,9 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Start-HistoricalSearch -EndDate -ReportTitle -ReportType -StartDate + [-BlockStatus ] [-CompressFile ] + [-ConnectorType ] [-DeliveryStatus ] [-Direction ] [-DLPPolicy ] @@ -35,6 +37,8 @@ Start-HistoricalSearch -EndDate -ReportTitle -ReportType ] [-RecipientAddress ] [-SenderAddress ] + [-SmtpSecurityError ] + [-TLSUsed ] [-TransportRule ] [-Url ] [] @@ -51,12 +55,12 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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: @@ -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 951cd95098..2afb3f3ca7 100644 --- a/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md +++ b/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) [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 973ef4e44d..a84f5ccd78 100644 --- a/exchange/exchange-ps/exchange/Start-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Start-MailboxSearch.md @@ -16,7 +16,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md b/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md index a10faec829..2e90b4cf4d 100644 --- a/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md +++ b/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md @@ -20,7 +20,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX -### Default +### Identity (Default) ``` Start-ManagedFolderAssistant [-Identity] [-HoldCleanup] [-AggMailboxCleanup] @@ -30,9 +30,9 @@ Start-ManagedFolderAssistant [-Identity] [-HoldCl [] ``` -### HoldCleanup +### ComplianceBoundaryAssistantParameterSet ``` -Start-ManagedFolderAssistant [-Identity] -HoldCleanup +Start-ManagedFolderAssistant [-Identity] [-AdaptiveScope] [-AggMailboxCleanup] [-Confirm] [-FullCrawl] @@ -41,9 +41,9 @@ Start-ManagedFolderAssistant [-Identity] -HoldCle [] ``` -### StopHoldCleanup +### ComplianceJobAssistantParameterSet ``` -Start-ManagedFolderAssistant [-Identity] [-StopHoldCleanup] +Start-ManagedFolderAssistant [-Identity] [-ComplianceJob] [-AggMailboxCleanup] [-Confirm] [-FullCrawl] @@ -52,10 +52,9 @@ Start-ManagedFolderAssistant [-Identity] [-StopHo [] ``` -### ComplianceBoundaryAssistant +### DataGovernanceAssistantParameterSet ``` -Start-ManagedFolderAssistant [-Identity] - [-AdaptiveScope] +Start-ManagedFolderAssistant [-Identity] [-DataGovernance] [-AggMailboxCleanup] [-Confirm] [-FullCrawl] @@ -64,7 +63,7 @@ Start-ManagedFolderAssistant [-Identity] [] ``` -### ElcB2DumpsterArchiverAssistant +### ElcB2DumpsterArchiverAssistantParameterSet ``` Start-ManagedFolderAssistant [-Identity] [-B2DumpsterArchiver] [-AggMailboxCleanup] @@ -75,7 +74,7 @@ Start-ManagedFolderAssistant [-Identity] [-B2Dump [] ``` -### ElcB2IPMArchiverAssistant +### ElcB2IPMArchiverAssistantParameterSet ``` Start-ManagedFolderAssistant [-Identity] [-B2IPMArchiver] [-AggMailboxCleanup] @@ -86,9 +85,9 @@ Start-ManagedFolderAssistant [-Identity] [-B2IPMA [] ``` -### ComplianceJobAssistant +### HoldCleanupParameterSet ``` -Start-ManagedFolderAssistant [-Identity] [-ComplianceJob] +Start-ManagedFolderAssistant [-Identity] [-HoldCleanup] [-AggMailboxCleanup] [-Confirm] [-FullCrawl] @@ -97,9 +96,9 @@ Start-ManagedFolderAssistant [-Identity] [-Compli [] ``` -### DataGovernanceAssistant +### StopHoldCleanupParameterSet ``` -Start-ManagedFolderAssistant [-Identity] [-DataGovernance] +Start-ManagedFolderAssistant [-Identity] [-StopHoldCleanup] [-AggMailboxCleanup] [-Confirm] [-FullCrawl] @@ -166,57 +165,6 @@ 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. - -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: HoldCleanup -Aliases: -Applicable: Exchange Server 2010, 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 -``` - -```yaml -Type: SwitchParameter -Parameter Sets: Default -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 -``` - -### -StopHoldCleanup -This parameter is available only in the cloud-based service. - -The StopHoldCleanup switch stops a previous hold clean-up command that was issued on the mailbox. You don't need to specify a value with this switch. - -A hold clean-up command will run until it completely scans the Recoverable Items folder for duplicate versions of items (it even continues after an interruption). In some cases, the hold clean-up command gets stuck, which can block other regular MRM tasks on the mailbox (for example, expiring items). The StopHoldCleanup switch tells MRM to abandon the stuck hold clean-up task so that regular tasks can continue. - -```yaml -Type: SwitchParameter -Parameter Sets: StopHoldCleanup -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AdaptiveScope This parameter is available only in the cloud-based service. @@ -224,7 +172,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: SwitchParameter -Parameter Sets: ComplianceBoundaryAssistant +Parameter Sets: ComplianceBoundaryAssistantParameterSet Aliases: Applicable: Exchange Online @@ -236,7 +184,9 @@ Accept wildcard characters: False ``` ### -AggMailboxCleanup -This parameter is reserved for internal Microsoft use. +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 @@ -258,7 +208,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: SwitchParameter -Parameter Sets: ElcB2DumpsterArchiverAssistant +Parameter Sets: ElcB2DumpsterArchiverAssistantParameterSet Aliases: Applicable: Exchange Online @@ -276,7 +226,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: SwitchParameter -Parameter Sets: ElcB2IPMArchiverAssistant +Parameter Sets: ElcB2IPMArchiverAssistantParameterSet Aliases: Applicable: Exchange Online @@ -294,7 +244,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter -Parameter Sets: ComplianceJobAssistant +Parameter Sets: ComplianceJobAssistantParameterSet Aliases: Applicable: Exchange Online @@ -331,7 +281,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter -Parameter Sets: DataGovernanceAssistant +Parameter Sets: DataGovernanceAssistantParameterSet Aliases: Applicable: Exchange Online @@ -349,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 @@ -367,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 @@ -378,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. @@ -389,7 +357,27 @@ When you use this switch, items aren't moved from the inactive mailbox to the ar ```yaml Type: SwitchParameter -Parameter Sets: ComplianceBoundaryAssistant, ComplianceJobAssistant, DataGovernanceAssistant, ElcB2DumpsterArchiverAssistant, ElcB2IPMArchiverAssistant, HoldCleanup, StopHoldCleanup +Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StopHoldCleanup +This parameter is available only in the cloud-based service. + +The StopHoldCleanup switch stops a previous hold clean-up command that was issued on the mailbox. You don't need to specify a value with this switch. + +A hold clean-up command will run until it completely scans the Recoverable Items folder for duplicate versions of items (it even continues after an interruption). In some cases, the hold clean-up command gets stuck, which can block other regular MRM tasks on the mailbox (for example, expiring items). The StopHoldCleanup switch tells MRM to abandon the stuck hold clean-up task so that regular tasks can continue. + +```yaml +Type: SwitchParameter +Parameter Sets: StopHoldCleanupParameterSet Aliases: Applicable: Exchange Online diff --git a/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md b/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md index 7d7f0b83ee..a0b52107ee 100644 --- a/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md @@ -32,7 +32,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi 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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-InformationBarrierPoliciesApplication.md b/exchange/exchange-ps/exchange/Stop-InformationBarrierPoliciesApplication.md index d1db633d5a..00b91d2c2c 100644 --- a/exchange/exchange-ps/exchange/Stop-InformationBarrierPoliciesApplication.md +++ b/exchange/exchange-ps/exchange/Stop-InformationBarrierPoliciesApplication.md @@ -28,7 +28,7 @@ Stop-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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://learn.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://learn.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 365ce54fe2..b78b8cb8b3 100644 --- a/exchange/exchange-ps/exchange/Stop-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Stop-MailboxSearch.md @@ -16,7 +16,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md index b4682a03ff..41e44b0123 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md @@ -16,7 +16,7 @@ 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://learn.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://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). diff --git a/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md b/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md index 25971b07b6..48f24eefda 100644 --- a/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -56,7 +56,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-CalendarConnectivity.md b/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md index 7108d7ec86..c2836a32a6 100644 --- a/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -56,7 +56,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 464f74988b..3389d80031 100644 --- a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Test-ClientAccessRule.md @@ -12,6 +12,9 @@ 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. @@ -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 4e27261a5c..7d9109fd68 100644 --- a/exchange/exchange-ps/exchange/Test-DataClassification.md +++ b/exchange/exchange-ps/exchange/Test-DataClassification.md @@ -39,7 +39,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 d4cfca56d0..81cf892ecd 100644 --- a/exchange/exchange-ps/exchange/Test-EcpConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-EcpConnectivity.md @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -55,7 +55,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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-ImapConnectivity.md b/exchange/exchange-ps/exchange/Test-ImapConnectivity.md index 4886eefdcf..44bf2c9053 100644 --- a/exchange/exchange-ps/exchange/Test-ImapConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-ImapConnectivity.md @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-ImapConnectivity cmdlet to verify that connectivity to the Microsoft Exchange IMAP4 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -56,11 +56,11 @@ 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-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://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)` @@ -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 68caaf3476..f166b0c365 100644 --- a/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md @@ -74,7 +74,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Test-Mailflow.md b/exchange/exchange-ps/exchange/Test-Mailflow.md index f95ba99089..628848623e 100644 --- a/exchange/exchange-ps/exchange/Test-Mailflow.md +++ b/exchange/exchange-ps/exchange/Test-Mailflow.md @@ -112,7 +112,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). 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 d4e76c88ae..d37917bd9e 100644 --- a/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md +++ b/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md @@ -122,7 +122,7 @@ Test-MigrationServerAvailability -ServiceAccountKeyFileData [-Gmail] ### Compliance ``` -Test-MigrationServerAvailability -Credentials -EmailAddress [-Compliance] +Test-MigrationServerAvailability -Credentials -EmailAddress [-Compliance] [-RemoteServer ] [-Confirm] [-Partition ] @@ -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,7 +258,7 @@ 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://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). diff --git a/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md index 270d9c7042..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://learn.microsoft.com/powershell/module/exchange/test-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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 @@ -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-OutlookWebServices.md b/exchange/exchange-ps/exchange/Test-OutlookWebServices.md index 1ac0c7b3dc..a9eae33fd1 100644 --- a/exchange/exchange-ps/exchange/Test-OutlookWebServices.md +++ b/exchange/exchange-ps/exchange/Test-OutlookWebServices.md @@ -20,7 +20,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX -### Default +### Default ``` Test-OutlookWebServices [[-Identity] ] [-ClientAccessServer ] @@ -63,7 +63,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 diff --git a/exchange/exchange-ps/exchange/Test-PopConnectivity.md b/exchange/exchange-ps/exchange/Test-PopConnectivity.md index 09214d6a9f..fedc41347a 100644 --- a/exchange/exchange-ps/exchange/Test-PopConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-PopConnectivity.md @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -56,7 +56,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 a88509dfb9..b418302280 100644 --- a/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -68,7 +68,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -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 ``` @@ -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-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-TextExtraction.md b/exchange/exchange-ps/exchange/Test-TextExtraction.md index e13ef7155c..43b3808f00 100644 --- a/exchange/exchange-ps/exchange/Test-TextExtraction.md +++ b/exchange/exchange-ps/exchange/Test-TextExtraction.md @@ -14,7 +14,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -29,7 +29,9 @@ Test-TextExtraction [-FileData] ``` ## DESCRIPTION -This cmdlet returns the text that is found in a file in Exchange. The Microsoft classification engine uses this text to classify content and determine which sensitive information types are found in this file/message. +This cmdlet doesn't work on encrypted email message files. + +The Microsoft classification engine uses the results to classify content and determine the sensitive information types in the message file. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -38,18 +40,20 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### 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 diff --git a/exchange/exchange-ps/exchange/Test-UMConnectivity.md b/exchange/exchange-ps/exchange/Test-UMConnectivity.md index be202b6e7f..7a6b3e9a41 100644 --- a/exchange/exchange-ps/exchange/Test-UMConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-UMConnectivity.md @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md b/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md index 082fa71953..fba4a45320 100644 --- a/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md @@ -16,7 +16,7 @@ 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://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -87,7 +87,7 @@ 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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md b/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md index ab8d9e99ed..7402d91bdb 100644 --- a/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md @@ -32,7 +32,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md index 0d4dd67dd6..dfbaff31dc 100644 --- a/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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-EOPDistributionGroupMember.md b/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md deleted file mode 100644 index e49103deb4..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://learn.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://learn.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://learn.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-ExchangeHelp.md b/exchange/exchange-ps/exchange/Update-ExchangeHelp.md index 3b4646189e..01778dcf54 100644 --- a/exchange/exchange-ps/exchange/Update-ExchangeHelp.md +++ b/exchange/exchange-ps/exchange/Update-ExchangeHelp.md @@ -28,7 +28,7 @@ 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://learn.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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md b/exchange/exchange-ps/exchange/Update-HybridConfiguration.md index 277ccde525..bb0e1ea9e9 100644 --- a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md +++ b/exchange/exchange-ps/exchange/Update-HybridConfiguration.md @@ -38,7 +38,9 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell $OnPremisesCreds = Get-Credential + $TenantCreds = Get-Credential + Update-HybridConfiguration -OnPremisesCredentials $OnPremisesCreds -TenantCredentials $TenantCreds ``` @@ -71,7 +73,10 @@ 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://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). diff --git a/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md b/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md index 5cf9763166..cfef60bbfd 100644 --- a/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md +++ b/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md @@ -45,7 +45,7 @@ Update-PublicFolderMailbox [-Identity] -FolderId -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 24a635ec66..bd36987193 100644 --- a/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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 02a8269da9..d0092da6bc 100644 --- a/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md @@ -101,7 +101,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: Named diff --git a/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md b/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md index 10b8bccff3..c4a8ee7175 100644 --- a/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md +++ b/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md @@ -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://learn.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be 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://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/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/exchange.md b/exchange/exchange-ps/exchange/exchange.md index 4961e4613c..8ead57cb12 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -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) @@ -155,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) @@ -206,10 +198,16 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [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) @@ -218,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) @@ -258,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) @@ -274,14 +276,16 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-SecOpsOverridePolicy](Get-SecOpsOverridePolicy.md) -### [Get-SecOpsOverrideRule](Get-SecOpsOverrideRule.md) - ### [Get-SenderFilterConfig](Get-SenderFilterConfig.md) ### [Get-SenderIdConfig](Get-SenderIdConfig.md) ### [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) @@ -290,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) @@ -304,8 +312,6 @@ 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) @@ -316,7 +322,9 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [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) @@ -328,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) @@ -356,8 +370,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-PhishSimOverridePolicy](Remove-PhishSimOverridePolicy.md) -### [Remove-PhishSimOverrideRule](Remove-PhishSimOverrideRule.md) - ### [Remove-QuarantinePolicy](Remove-QuarantinePolicy.md) ### [Remove-ReportSubmissionPolicy](Remove-ReportSubmissionPolicy.md) @@ -366,14 +378,14 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [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) @@ -382,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) @@ -414,8 +430,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-PhishSimOverridePolicy](Set-PhishSimOverridePolicy.md) -### [Set-PhishSimOverrideRule](Set-PhishSimOverrideRule.md) - ### [Set-QuarantinePermissions](Set-QuarantinePermissions.md) ### [Set-QuarantinePolicy](Set-QuarantinePolicy.md) @@ -428,14 +442,16 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-SecOpsOverridePolicy](Set-SecOpsOverridePolicy.md) -### [Set-SecOpsOverrideRule](Set-SecOpsOverrideRule.md) - ### [Set-SenderFilterConfig](Set-SenderFilterConfig.md) ### [Set-SenderIdConfig](Set-SenderIdConfig.md) ### [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) @@ -939,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) @@ -981,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) @@ -1048,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) @@ -1089,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) @@ -1153,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) @@ -1280,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) @@ -1292,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) @@ -1302,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) @@ -1332,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) @@ -1600,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) @@ -1622,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) @@ -1634,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) @@ -1654,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) @@ -1674,6 +1722,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Test-OAuthConnectivity](Test-OAuthConnectivity.md) +### [Test-ServicePrincipalAuthorization](Test-ServicePrincipalAuthorization.md) + ### [Test-SystemHealth](Test-SystemHealth.md) ### [Update-ExchangeHelp](Update-ExchangeHelp.md) @@ -1699,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) @@ -1733,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) @@ -1749,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) @@ -1777,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) @@ -1799,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) @@ -1844,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) @@ -1856,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) @@ -1880,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) @@ -2090,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) @@ -2148,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) @@ -2282,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) @@ -2291,6 +2331,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-ConnectionInformation](Get-ConnectionInformation.md) +### [Get-DefaultTenantBriefingConfig](Get-DefaultTenantBriefingConfig.md) + +### [Get-DefaultTenantMyAnalyticsFeatureConfig](Get-DefaultTenantMyAnalyticsFeatureConfig.md) + ### [Get-EXOCasMailbox](Get-EXOCasMailbox.md) ### [Get-EXOMailbox](Get-EXOMailbox.md) @@ -2315,57 +2359,39 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-VivaInsightsSettings](Get-VivaInsightsSettings.md) -### [Set-MyAnalyticsFeatureConfig](Set-MyAnalyticsFeatureConfig.md) +### [Get-VivaModuleFeature](Get-VivaModuleFeature.md) -### [Set-UserBriefingConfig](Set-UserBriefingConfig.md) +### [Get-VivaModuleFeatureEnablement](Get-VivaModuleFeatureEnablement.md) -### [Set-VivaInsightsSettings](Set-VivaInsightsSettings.md) - -## reporting Cmdlets -### [Get-CompromisedUserAggregateReport](Get-CompromisedUserAggregateReport.md) - -### [Get-CompromisedUserDetailReport](Get-CompromisedUserDetailReport.md) - -### [Get-ConnectionByClientTypeDetailReport](Get-ConnectionByClientTypeDetailReport.md) +### [Get-VivaModuleFeaturePolicy](Get-VivaModuleFeaturePolicy.md) -### [Get-ConnectionByClientTypeReport](Get-ConnectionByClientTypeReport.md) +### [Get-VivaOrgInsightsDelegatedRole](Get-VivaOrgInsightsDelegatedRole.md) -### [Get-CsActiveUserReport](Get-CsActiveUserReport.md) +### [Remove-VivaModuleFeaturePolicy](Remove-VivaModuleFeaturePolicy.md) -### [Get-CsAVConferenceTimeReport](Get-CsAVConferenceTimeReport.md) +### [Remove-VivaOrgInsightsDelegatedRole](Remove-VivaOrgInsightsDelegatedRole.md) -### [Get-CsClientDeviceDetailReport](Get-CsClientDeviceDetailReport.md) +### [Set-DefaultTenantBriefingConfig](Set-DefaultTenantBriefingConfig.md) -### [Get-CsClientDeviceReport](Get-CsClientDeviceReport.md) +### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md) -### [Get-CsConferenceReport](Get-CsConferenceReport.md) - -### [Get-CsP2PAVTimeReport](Get-CsP2PAVTimeReport.md) - -### [Get-CsP2PSessionReport](Get-CsP2PSessionReport.md) +### [Set-MyAnalyticsFeatureConfig](Set-MyAnalyticsFeatureConfig.md) -### [Get-CsPSTNConferenceTimeReport](Get-CsPSTNConferenceTimeReport.md) +### [Set-UserBriefingConfig](Set-UserBriefingConfig.md) -### [Get-CsPSTNUsageDetailReport](Get-CsPSTNUsageDetailReport.md) +### [Set-VivaInsightsSettings](Set-VivaInsightsSettings.md) -### [Get-CsUserActivitiesReport](Get-CsUserActivitiesReport.md) +### [Update-VivaModuleFeaturePolicy](Update-VivaModuleFeaturePolicy.md) -### [Get-CsUsersBlockedReport](Get-CsUsersBlockedReport.md) +## reporting Cmdlets +### [Get-CompromisedUserAggregateReport](Get-CompromisedUserAggregateReport.md) -### [Get-GroupActivityReport](Get-GroupActivityReport.md) +### [Get-CompromisedUserDetailReport](Get-CompromisedUserDetailReport.md) ### [Get-HistoricalSearch](Get-HistoricalSearch.md) -### [Get-LicenseVsUsageSummaryReport](Get-LicenseVsUsageSummaryReport.md) - ### [Get-LogonStatistics](Get-LogonStatistics.md) -### [Get-MailboxActivityReport](Get-MailboxActivityReport.md) - -### [Get-MailboxUsageDetailReport](Get-MailboxUsageDetailReport.md) - -### [Get-MailboxUsageReport](Get-MailboxUsageReport.md) - ### [Get-MailDetailDlpPolicyReport](Get-MailDetailDlpPolicyReport.md) ### [Get-MailDetailEncryptionReport](Get-MailDetailEncryptionReport.md) @@ -2382,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) @@ -2404,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) @@ -2430,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) @@ -2807,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) @@ -2823,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) @@ -2841,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) @@ -2865,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 df109bd7f3..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,7 +33,6 @@ "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", @@ -65,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", @@ -90,15 +86,21 @@ "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", @@ -117,7 +119,6 @@ "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", @@ -125,14 +126,17 @@ "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", @@ -140,21 +144,24 @@ "New-MalwareFilterPolicy": "antispam-antimalware", "New-MalwareFilterRule": "antispam-antimalware", "New-PhishSimOverridePolicy": "antispam-antimalware", - "New-PhishSimOverrideRule": "antispam-antimalware", "New-QuarantinePermissions": "antispam-antimalware", "New-QuarantinePolicy": "antispam-antimalware", "New-ReportSubmissionPolicy": "antispam-antimalware", "New-ReportSubmissionRule": "antispam-antimalware", "New-SecOpsOverridePolicy": "antispam-antimalware", - "New-SecOpsOverrideRule": "antispam-antimalware", + "New-TeamsProtectionPolicy": "antispam-antimalware", + "New-TeamsProtectionPolicyRule": "antispam-antimalware", "New-TenantAllowBlockListItems": "antispam-antimalware", "New-TenantAllowBlockListSpoofItems": "antispam-antimalware", "Preview-QuarantineMessage": "antispam-antimalware", "Release-QuarantineMessage": "antispam-antimalware", "Remove-AttachmentFilterEntry": "antispam-antimalware", + "Remove-BlockedConnector": "antispam-antimalware", "Remove-BlockedSenderAddress": "antispam-antimalware", "Remove-ContentFilterPhrase": "antispam-antimalware", "Remove-EOPProtectionPolicyRule": "antispam-antimalware", + "Remove-ExoPhishSimOverrideRule": "antispam-antimalware", + "Remove-ExoSecOpsOverrideRule": "antispam-antimalware", "Remove-HostedContentFilterPolicy": "antispam-antimalware", "Remove-HostedContentFilterRule": "antispam-antimalware", "Remove-HostedOutboundSpamFilterPolicy": "antispam-antimalware", @@ -166,19 +173,20 @@ "Remove-MalwareFilterPolicy": "antispam-antimalware", "Remove-MalwareFilterRule": "antispam-antimalware", "Remove-PhishSimOverridePolicy": "antispam-antimalware", - "Remove-PhishSimOverrideRule": "antispam-antimalware", "Remove-QuarantinePolicy": "antispam-antimalware", "Remove-ReportSubmissionPolicy": "antispam-antimalware", "Remove-ReportSubmissionRule": "antispam-antimalware", "Remove-SecOpsOverridePolicy": "antispam-antimalware", - "Remove-SecOpsOverrideRule": "antispam-antimalware", "Remove-TenantAllowBlockListItems": "antispam-antimalware", "Remove-TenantAllowBlockListSpoofItems": "antispam-antimalware", "Rotate-DkimSigningConfig": "antispam-antimalware", + "Set-ArcConfig": "antispam-antimalware", "Set-AttachmentFilterListConfig": "antispam-antimalware", "Set-ContentFilterConfig": "antispam-antimalware", "Set-DkimSigningConfig": "antispam-antimalware", "Set-EOPProtectionPolicyRule": "antispam-antimalware", + "Set-ExoPhishSimOverrideRule": "antispam-antimalware", + "Set-ExoSecOpsOverrideRule": "antispam-antimalware", "Set-HostedConnectionFilterPolicy": "antispam-antimalware", "Set-HostedContentFilterPolicy": "antispam-antimalware", "Set-HostedContentFilterRule": "antispam-antimalware", @@ -195,17 +203,17 @@ "Set-MalwareFilterPolicy": "antispam-antimalware", "Set-MalwareFilterRule": "antispam-antimalware", "Set-PhishSimOverridePolicy": "antispam-antimalware", - "Set-PhishSimOverrideRule": "antispam-antimalware", "Set-QuarantinePermissions": "antispam-antimalware", "Set-QuarantinePolicy": "antispam-antimalware", "Set-RecipientFilterConfig": "antispam-antimalware", "Set-ReportSubmissionPolicy": "antispam-antimalware", "Set-ReportSubmissionRule": "antispam-antimalware", "Set-SecOpsOverridePolicy": "antispam-antimalware", - "Set-SecOpsOverrideRule": "antispam-antimalware", "Set-SenderFilterConfig": "antispam-antimalware", "Set-SenderIdConfig": "antispam-antimalware", "Set-SenderReputationConfig": "antispam-antimalware", + "Set-TeamsProtectionPolicy": "antispam-antimalware", + "Set-TeamsProtectionPolicyRule": "antispam-antimalware", "Set-TenantAllowBlockListItems": "antispam-antimalware", "Set-TenantAllowBlockListSpoofItems": "antispam-antimalware", "Test-IPAllowListProvider": "antispam-antimalware", @@ -455,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", @@ -476,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", @@ -509,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", @@ -529,6 +536,7 @@ "Enable-Mailbox": "mailboxes", "Enable-ServiceEmailChannel": "mailboxes", "Enable-SweepRule": "mailboxes", + "Expedite-Delicensing": "mailboxes", "Export-MailboxDiagnosticLogs": "mailboxes", "Export-RecipientDataProperty": "mailboxes", "Get-App": "mailboxes", @@ -561,6 +569,7 @@ "Get-MailboxStatistics": "mailboxes", "Get-MailboxUserConfiguration": "mailboxes", "Get-MessageCategory": "mailboxes", + "Get-PendingDelicenseUser": "mailboxes", "Get-Place": "mailboxes", "Get-RecipientPermission": "mailboxes", "Get-RecoverableItems": "mailboxes", @@ -624,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", @@ -650,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", @@ -780,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", @@ -794,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", @@ -810,8 +832,10 @@ "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", @@ -820,6 +844,7 @@ "Set-SettingOverride": "organization", "Test-ApplicationAccessPolicy": "organization", "Test-OAuthConnectivity": "organization", + "Test-ServicePrincipalAuthorization": "organization", "Test-SystemHealth": "organization", "Update-ExchangeHelp": "organization", "Disable-JournalArchiving": "policy-and-compliance", @@ -832,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", @@ -849,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", @@ -857,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", @@ -871,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", @@ -882,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", @@ -904,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", @@ -1026,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", @@ -1055,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", @@ -1122,47 +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-EXOCasMailbox": "powershell-v2-module", - "Get-EXOMailbox": "powershell-v2-module", - "Get-EXOMailboxFolderPermission": "powershell-v2-module", - "Get-EXOMailboxFolderStatistics": "powershell-v2-module", - "Get-EXOMailboxPermission": "powershell-v2-module", - "Get-EXOMailboxStatistics": "powershell-v2-module", - "Get-EXOMobileDeviceStatistics": "powershell-v2-module", - "Get-EXORecipient": "powershell-v2-module", - "Get-EXORecipientPermission": "powershell-v2-module", - "Get-MyAnalyticsFeatureConfig": "powershell-v2-module", - "Get-UserBriefingConfig": "powershell-v2-module", - "Get-VivaInsightsSettings": "powershell-v2-module", - "Set-MyAnalyticsFeatureConfig": "powershell-v2-module", - "Set-UserBriefingConfig": "powershell-v2-module", - "Set-VivaInsightsSettings": "powershell-v2-module", + "Add-VivaModuleFeaturePolicy": "powershell-v3-module", + "Add-VivaOrgInsightsDelegatedRole": "powershell-v3-module", + "Connect-ExchangeOnline": "powershell-v3-module", + "Connect-IPPSSession": "powershell-v3-module", + "Disconnect-ExchangeOnline": "powershell-v3-module", + "Get-ConnectionInformation": "powershell-v3-module", + "Get-DefaultTenantBriefingConfig": "powershell-v3-module", + "Get-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v3-module", + "Get-EXOCasMailbox": "powershell-v3-module", + "Get-EXOMailbox": "powershell-v3-module", + "Get-EXOMailboxFolderPermission": "powershell-v3-module", + "Get-EXOMailboxFolderStatistics": "powershell-v3-module", + "Get-EXOMailboxPermission": "powershell-v3-module", + "Get-EXOMailboxStatistics": "powershell-v3-module", + "Get-EXOMobileDeviceStatistics": "powershell-v3-module", + "Get-EXORecipient": "powershell-v3-module", + "Get-EXORecipientPermission": "powershell-v3-module", + "Get-MyAnalyticsFeatureConfig": "powershell-v3-module", + "Get-UserBriefingConfig": "powershell-v3-module", + "Get-VivaInsightsSettings": "powershell-v3-module", + "Get-VivaModuleFeature": "powershell-v3-module", + "Get-VivaModuleFeatureEnablement": "powershell-v3-module", + "Get-VivaModuleFeaturePolicy": "powershell-v3-module", + "Get-VivaOrgInsightsDelegatedRole": "powershell-v3-module", + "Remove-VivaModuleFeaturePolicy": "powershell-v3-module", + "Remove-VivaOrgInsightsDelegatedRole": "powershell-v3-module", + "Set-DefaultTenantBriefingConfig": "powershell-v3-module", + "Set-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v3-module", + "Set-MyAnalyticsFeatureConfig": "powershell-v3-module", + "Set-UserBriefingConfig": "powershell-v3-module", + "Set-VivaInsightsSettings": "powershell-v3-module", + "Update-VivaModuleFeaturePolicy": "powershell-v3-module", "Get-CompromisedUserAggregateReport": "reporting", "Get-CompromisedUserDetailReport": "reporting", - "Get-ConnectionByClientTypeDetailReport": "reporting", - "Get-ConnectionByClientTypeReport": "reporting", - "Get-CsActiveUserReport": "reporting", - "Get-CsAVConferenceTimeReport": "reporting", - "Get-CsClientDeviceDetailReport": "reporting", - "Get-CsClientDeviceReport": "reporting", - "Get-CsConferenceReport": "reporting", - "Get-CsP2PAVTimeReport": "reporting", - "Get-CsP2PSessionReport": "reporting", - "Get-CsPSTNConferenceTimeReport": "reporting", - "Get-CsPSTNUsageDetailReport": "reporting", - "Get-CsUserActivitiesReport": "reporting", - "Get-CsUsersBlockedReport": "reporting", - "Get-GroupActivityReport": "reporting", "Get-HistoricalSearch": "reporting", - "Get-LicenseVsUsageSummaryReport": "reporting", "Get-LogonStatistics": "reporting", - "Get-MailboxActivityReport": "reporting", - "Get-MailboxUsageDetailReport": "reporting", - "Get-MailboxUsageReport": "reporting", "Get-MailDetailDlpPolicyReport": "reporting", "Get-MailDetailEncryptionReport": "reporting", "Get-MailDetailTransportRuleReport": "reporting", @@ -1171,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", @@ -1381,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", @@ -1398,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", @@ -1410,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/NEW_CMDLETS.md b/repo_docs/NEW_CMDLETS.md index e37d0622e9..fbbbaaefc1 100644 --- a/repo_docs/NEW_CMDLETS.md +++ b/repo_docs/NEW_CMDLETS.md @@ -4,37 +4,17 @@ 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 @@ -46,16 +26,23 @@ You probably know how to do this already, but the available workloads and connec > Use `Upgrade-Module` and also `Uninstall-Module` depending on the module version you have installed. - Exchange: - - Exchange Online: [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) - - Security & Compliance: [Connect to Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-scc-powershell) - - Exchange Online Protection: [Connect to Exchange Online Protection PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-protection-powershell) - - Exchange Server: [Connect to Exchange servers using remote PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-servers-using-remote-powershell) + - 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) -**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. - -- 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. @@ -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,30 +285,7 @@ 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: - -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. - - When you're ready, click the green **Propose file change** button. - - ![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) - -> [!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. +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). ## Appendix @@ -391,16 +299,31 @@ After you're done editing the TOC files: - -### Install platyPS on older versions of Windows (WMF 3.0 or 4.0) +### Install platyPS on older versions of Windows + +> [!NOTE] +> The procedures in this section aren't required in current versions of Windows (Windows 10, Windows Server 2016, or later) or other versions of Windows where the WMF 5.1 is already installed. + +The following older versions of Windows don't automatically include Windows PowerShell 5.1, but they support it. You need to download and install the Windows Management Framework (WMF) 5.1 from on these versions of Windows: + +- Windows 8.1 +- Windows Server 2012 or Windows Server 2012 R2 +- Windows 7 Service Pack 1 (SP1)1,2 +- Windows Server 2008 R2 SP11,2 + +- 1 This version of Windows has reached its end of support, and is now supported only in Azure virtual machines. +- 2 Windows PowerShell 5.1 on this version of Windows requires the .NET Framework 4.5 or later. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). + +### Install platyPS on 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://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 511d26ff37..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://learn.microsoft.com/powershell/module/skype/add-cssladelegates -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +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 diff --git a/skype/skype-ps/skype/Clear-CsOnlineTelephoneNumberReservation.md b/skype/skype-ps/skype/Clear-CsOnlineTelephoneNumberReservation.md deleted file mode 100644 index 55edf8598b..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://learn.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://learn.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 f065488ca3..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://learn.microsoft.com/powershell/module/skype/clear-cspersistentchatroom -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Clear-CsPersistentChatRoom schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md b/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md index 45222d8f25..a337781345 100644 --- a/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md +++ b/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # ConvertTo-JsonForPSWS diff --git a/skype/skype-ps/skype/Copy-CsVoicePolicy.md b/skype/skype-ps/skype/Copy-CsVoicePolicy.md index bf0f729ec0..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://learn.microsoft.com/powershell/module/skype/copy-csvoicepolicy -applicable: Lync Server 2013, Skype for Business Online +applicable: Lync Server 2013 title: Copy-CsVoicePolicy schema: 2.0.0 manager: bulenteg diff --git a/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md b/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md index 8bef7a1dbc..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://learn.microsoft.com/powershell/module/skype/debug-csunifiedcontactstore -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +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 diff --git a/skype/skype-ps/skype/Disable-CsMeetingRoom.md b/skype/skype-ps/skype/Disable-CsMeetingRoom.md index e3a4eea8fc..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://learn.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 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Disable-CsMeetingRoom schema: 2.0.0 manager: bulenteg diff --git a/skype/skype-ps/skype/Disable-CsOnlineDialInConferencingUser.md b/skype/skype-ps/skype/Disable-CsOnlineDialInConferencingUser.md deleted file mode 100644 index 2c8a0fe7b3..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://learn.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://learn.microsoft.com/powershell/module/skype/enable-csonlinedialinconferencinguser?view=skype-ps) - -[Get-CsOnlineDialInConferencingUser](https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinguser?view=skype-ps) - -[Set-CsOnlineDialInConferencingUser](https://learn.microsoft.com/powershell/module/skype/set-csonlinedialinconferencinguser?view=skype-ps) diff --git a/skype/skype-ps/skype/Enable-CsMeetingRoom.md b/skype/skype-ps/skype/Enable-CsMeetingRoom.md index c02720336f..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://learn.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 +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://learn.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://learn.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. diff --git a/skype/skype-ps/skype/Enable-CsOnlineDialInConferencingUser.md b/skype/skype-ps/skype/Enable-CsOnlineDialInConferencingUser.md deleted file mode 100644 index faaf69e6b5..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://learn.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://learn.microsoft.com/powershell/module/skype/disable-csonlinedialinconferencinguser?view=skype-ps) - -[Get-CsOnlineDialInConferencingUser](https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinguser?view=skype-ps) - -[Set-CsOnlineDialInConferencingUser](https://learn.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/Export-CsOrganizationalAutoAttendantHolidays.md b/skype/skype-ps/skype/Export-CsOrganizationalAutoAttendantHolidays.md deleted file mode 100644 index d94eda3919..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://learn.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 21f3a7f2bd..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://learn.microsoft.com/powershell/module/skype/export-cspersistentchatdata -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Export-CsPersistentChatData schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsApplicationAccessPolicy.md b/skype/skype-ps/skype/Get-CsApplicationAccessPolicy.md deleted file mode 100644 index 436a1a5fe2..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://learn.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-CsAudioConferencingProvider.md b/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md index da03f803db..b3dc99ff07 100644 --- a/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md +++ b/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsAudioConferencingProvider diff --git a/skype/skype-ps/skype/Get-CsAuthConfig.md b/skype/skype-ps/skype/Get-CsAuthConfig.md index 863e6a56f5..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://learn.microsoft.com/powershell/module/skype/get-csauthconfig -applicable: Skype for Business Server 2019 +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 48c602a7ad..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://learn.microsoft.com/powershell/module/skype/get-csautodiscoverconfiguration -applicable: 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 title: Get-CsAutodiscoverConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md b/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md index ce30ce83c2..82470cd5a7 100644 --- a/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md +++ b/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsBroadcastMeetingConfiguration diff --git a/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md b/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md index 86f78011dc..acdf4bbf3d 100644 --- a/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md +++ b/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsBroadcastMeetingPolicy diff --git a/skype/skype-ps/skype/Get-CsClientPolicy.md b/skype/skype-ps/skype/Get-CsClientPolicy.md index 3629c982f0..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md b/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md index 725ecfd30b..0cec065b8a 100644 --- a/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md +++ b/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md @@ -7,7 +7,7 @@ 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-CsConferencingPolicy.md b/skype/skype-ps/skype/Get-CsConferencingPolicy.md index ce9e206e13..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md b/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md index 8384ea53b0..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://learn.microsoft.com/powershell/module/skype/get-csdatabasemirrorstate -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsDatabaseMirrorState schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md b/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md index c186f4974f..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md index 487073ef67..f3dc30cd98 100644 --- a/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsExternalUserCommunicationPolicy diff --git a/skype/skype-ps/skype/Get-CsGraphPolicy.md b/skype/skype-ps/skype/Get-CsGraphPolicy.md index de150ba2d8..69cd22f5e8 100644 --- a/skype/skype-ps/skype/Get-CsGraphPolicy.md +++ b/skype/skype-ps/skype/Get-CsGraphPolicy.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsGraphPolicy diff --git a/skype/skype-ps/skype/Get-CsHostingProvider.md b/skype/skype-ps/skype/Get-CsHostingProvider.md index 0a5120882c..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsHuntGroup.md b/skype/skype-ps/skype/Get-CsHuntGroup.md deleted file mode 100644 index 5274dfdb39..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://learn.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 0915fa8590..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://learn.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-CsHybridMediationServer.md b/skype/skype-ps/skype/Get-CsHybridMediationServer.md index 4dbcf55f03..22a1a60c23 100644 --- a/skype/skype-ps/skype/Get-CsHybridMediationServer.md +++ b/skype/skype-ps/skype/Get-CsHybridMediationServer.md @@ -7,7 +7,7 @@ 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 6c99a5d2c9..35c6ae3de8 100644 --- a/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsHybridPSTNAppliance diff --git a/skype/skype-ps/skype/Get-CsHybridPSTNSite.md b/skype/skype-ps/skype/Get-CsHybridPSTNSite.md index ad78f02a6d..3bfc36476a 100644 --- a/skype/skype-ps/skype/Get-CsHybridPSTNSite.md +++ b/skype/skype-ps/skype/Get-CsHybridPSTNSite.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsHybridPSTNSite diff --git a/skype/skype-ps/skype/Get-CsIPPhonePolicy.md b/skype/skype-ps/skype/Get-CsIPPhonePolicy.md index ef05fd091c..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://learn.microsoft.com/powershell/module/skype/get-csipphonepolicy -applicable: Skype for Business Online, Skype for Business Server 2019 +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 diff --git a/skype/skype-ps/skype/Get-CsImFilterConfiguration.md b/skype/skype-ps/skype/Get-CsImFilterConfiguration.md index 72478c0720..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsMcxConfiguration.md b/skype/skype-ps/skype/Get-CsMcxConfiguration.md index b478800106..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://learn.microsoft.com/powershell/module/skype/get-csmcxconfiguration -applicable: 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 title: Get-CsMcxConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsMeetingConfiguration.md b/skype/skype-ps/skype/Get-CsMeetingConfiguration.md index b49867bd1e..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsMeetingRoom.md b/skype/skype-ps/skype/Get-CsMeetingRoom.md index 00834d17f2..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://learn.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 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsMeetingRoom schema: 2.0.0 manager: bulenteg diff --git a/skype/skype-ps/skype/Get-CsMobilityPolicy.md b/skype/skype-ps/skype/Get-CsMobilityPolicy.md index 6cbab232d4..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsNetworkConfiguration.md b/skype/skype-ps/skype/Get-CsNetworkConfiguration.md index 06bc31c4f2..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsOAuthConfiguration.md b/skype/skype-ps/skype/Get-CsOAuthConfiguration.md index b6a01f8633..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://learn.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 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsOAuthConfiguration schema: 2.0.0 manager: bulenteg diff --git a/skype/skype-ps/skype/Get-CsOnlineApplicationEndpoint.md b/skype/skype-ps/skype/Get-CsOnlineApplicationEndpoint.md deleted file mode 100644 index de701bdf7e..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://learn.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://learn.microsoft.com/powershell/module/skype/set-csonlineapplicationendpoint) - -[New-CsOnlineApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-csonlineapplicationendpoint) - -[Remove-CsOnlineApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-csonlineapplicationendpoint) - -[Set up a Trusted Application Endpoint](https://learn.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 07887e94b3..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://learn.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 5b55cedcc7..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://learn.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://learn.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://learn.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://learn.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 715681445c..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://learn.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://learn.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 0dd859842b..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineDirectoryTenantNumberCities.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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://learn.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 dbefcfb914..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineNumberPortInOrder.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 3a857593b8..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineNumberPortOutOrderPin.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 e019d4e624..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberAvailableCount.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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://learn.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 fd7ef6a89c..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryAreas.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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://learn.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 295c1344da..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCities.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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://learn.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 ca29cd80a0..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryCountries.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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://learn.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 ab99695bb3..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryRegions.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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://learn.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 d4be71c516..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberInventoryTypes.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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://learn.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 e27d213690..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumberReservationsInformation.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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://learn.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 e873ec5670..0000000000 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ /dev/null @@ -1,644 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csonlineuser -applicable: Microsoft Teams, Skype for Business Online -title: Get-CsOnlineUser -schema: 2.0.0 -manager: bulenteg -author: isrumnon -ms.author: isrumnon -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. - -### -------------------------- 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 (available from January 31, 2023, in the latest TPM versions at that time). -- `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 -- CallingLineIdentity -- Company -- Country -- Department -- DisplayName -- EnterpriseVoiceEnabled -- ExternalAccessPolicy -- FeatureTypes (new) -- GivenName -- Identity -- IsSipEnabled -- LastName (available in Teams PowerShell Module 4.2.1 and later) -- LineUri -- UserPrincipalName -- OnlineAudioConferencingRoutingPolicy -- OnlineDialOutPolicy -- OnlineVoicemailPolicy -- OnlineVoiceRoutingPolicy -- OwnerUrn -- TeamsAppPermissionPolicy -- TeamsAppSetupPolicy -- TeamsAudioConferencingPolicy -- TeamsCallHoldPolicy -- TeamsCallingPolicy -- TeamsCallParkPolicy -- TeamsChannelsPolicy -- TeamsComplianceRecordingPolicy -- TeamsCortanaPolicy -- TenantDialPlan -- TeamsEducationAssignmentsAppPolicy -- TeamsEmergencyCallingPolicy -- TeamsEmergencyCallRoutingPolicy -- TeamsFeedbackPolicy -- TeamsIPPhonePolicy -- TeamsMeetingBrandingPolicy -- TeamsMeetingBroadcastPolicy -- TeamsMeetingPolicy -- TeamsMessagingPolicy -- TeamsMobilityPolicy -- TeamsNotificationAndFeedsPolicy -- TeamsShiftsAppPolicy -- TeamsShiftsPolicy -- TeamsSurvivableBranchAppliancePolicy -- TeamsSyntheticAutomatedCallPolicy -- TeamsTargetingPolicy -- TeamsTemplatePermissionPolicy -- TeamsUpdateManagementPolicy -- TeamsUpgradeOverridePolicy -- TeamsUpgradePolicy -- TeamsVdiPolicy -- TeamsVerticalPackagePolicy -- TeamsVideoInteropServicePolicy -- TeamsWorkLoadPolicy -- Title -- UsageLocation -- UserDirSyncEnabled -- VoiceRoutingPolicy - -*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 -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: 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 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 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 - -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 fd123c0037..0000000000 --- a/skype/skype-ps/skype/Get-CsOrganizationalAutoAttendant.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 60bc947b6f..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://learn.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 c5a418d568..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://learn.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 5925a25d5d..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://learn.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 c811fa7c19..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://learn.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 13badf8caf..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://learn.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-CsPersistentChatAddin.md b/skype/skype-ps/skype/Get-CsPersistentChatAddin.md index 908b628669..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://learn.microsoft.com/powershell/module/skype/get-cspersistentchataddin -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatAddin schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsPersistentChatCategory.md b/skype/skype-ps/skype/Get-CsPersistentChatCategory.md index 9ecb229450..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://learn.microsoft.com/powershell/module/skype/get-cspersistentchatcategory -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatCategory schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md index 2b0485dc53..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://learn.microsoft.com/powershell/module/skype/get-cspersistentchatcomplianceconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatComplianceConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md b/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md index b8e54ca6b8..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://learn.microsoft.com/powershell/module/skype/get-cspersistentchatconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md b/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md index f44036d0b7..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://learn.microsoft.com/powershell/module/skype/get-cspersistentchateligibleprincipal -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatEligiblePrincipal schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md b/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md index c514eb8a86..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://learn.microsoft.com/powershell/module/skype/get-cspersistentchatendpoint -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatEndpoint schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md b/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md index e9f26ecc95..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://learn.microsoft.com/powershell/module/skype/get-cspersistentchatpolicy -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatPolicy schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsPersistentChatRoom.md b/skype/skype-ps/skype/Get-CsPersistentChatRoom.md index 3d3818dbed..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://learn.microsoft.com/powershell/module/skype/get-cspersistentchatroom -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatRoom schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsPersistentChatState.md b/skype/skype-ps/skype/Get-CsPersistentChatState.md index 043ec33ec1..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://learn.microsoft.com/powershell/module/skype/get-cspersistentchatstate -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsPersistentChatState schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md b/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md index a4bd7778b9..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://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +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 diff --git a/skype/skype-ps/skype/Get-CsPresencePolicy.md b/skype/skype-ps/skype/Get-CsPresencePolicy.md index 7491d8f795..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md b/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md index a1f203b7d7..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md b/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md index f8187c893a..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md b/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md index 59780393e2..aa3aa23c6e 100644 --- a/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md @@ -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. diff --git a/skype/skype-ps/skype/Get-CsSlaConfiguration.md b/skype/skype-ps/skype/Get-CsSlaConfiguration.md index 772777fc94..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://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsSlaConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md b/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md index eba296a688..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://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration -applicable: Skype for Business Online, Skype for Business Server 2019 +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsTeamsUpgradeConfiguration schema: 2.0.0 manager: bulenteg diff --git a/skype/skype-ps/skype/Get-CsTeamsUpgradeStatus.md b/skype/skype-ps/skype/Get-CsTeamsUpgradeStatus.md deleted file mode 100644 index 56a338f184..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://learn.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://learn.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://learn.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://learn.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-CsTenantHybridConfiguration.md b/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md index 0d0b828757..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://learn.microsoft.com/powershell/module/skype/get-cstenanthybridconfiguration -applicable: Skype for Business Online +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 diff --git a/skype/skype-ps/skype/Get-CsTenantPublicProvider.md b/skype/skype-ps/skype/Get-CsTenantPublicProvider.md deleted file mode 100644 index 36802c921d..0000000000 --- a/skype/skype-ps/skype/Get-CsTenantPublicProvider.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 28d2cab116..375176efc1 100644 --- a/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsTenantUpdateTimeWindow diff --git a/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md b/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md index ffb03e6770..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsUserAcp.md b/skype/skype-ps/skype/Get-CsUserAcp.md index c4234ed361..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Get-CsUserLocationStatus.md b/skype/skype-ps/skype/Get-CsUserLocationStatus.md index 3b3be9b863..88057a3b23 100644 --- a/skype/skype-ps/skype/Get-CsUserLocationStatus.md +++ b/skype/skype-ps/skype/Get-CsUserLocationStatus.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsUserLocationStatus diff --git a/skype/skype-ps/skype/Get-CsUserPstnSettings.md b/skype/skype-ps/skype/Get-CsUserPstnSettings.md index 1d9aeb5060..0db2a2b553 100644 --- a/skype/skype-ps/skype/Get-CsUserPstnSettings.md +++ b/skype/skype-ps/skype/Get-CsUserPstnSettings.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsUserPstnSettings diff --git a/skype/skype-ps/skype/Get-CsUserServicesPolicy.md b/skype/skype-ps/skype/Get-CsUserServicesPolicy.md index f084bc8568..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://learn.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 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsUserServicesPolicy schema: 2.0.0 manager: bulenteg diff --git a/skype/skype-ps/skype/Get-CsUserSession.md b/skype/skype-ps/skype/Get-CsUserSession.md index b143aaf6b8..8871e70049 100644 --- a/skype/skype-ps/skype/Get-CsUserSession.md +++ b/skype/skype-ps/skype/Get-CsUserSession.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Get-CsUserSession diff --git a/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md b/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md index 6bc75fe7b4..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://learn.microsoft.com/powershell/module/skype/get-csusersettingspageconfiguration -applicable: Skype for Business Server 2019 +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-CsVideoTrunkConfiguration.md b/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md index 43f7a57212..fc9b683da3 100644 --- a/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md @@ -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. diff --git a/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md b/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md index 8238b41721..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://learn.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 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsVoiceRoutingPolicy schema: 2.0.0 manager: bulenteg diff --git a/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md b/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md index 34af7eb141..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://learn.microsoft.com/powershell/module/skype/get-csxmppallowedpartner -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsXmppAllowedPartner schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md b/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md index 3d8bc5d899..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://learn.microsoft.com/powershell/module/skype/get-csxmppgatewayconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Get-CsXmppGatewayConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Grant-CsBroadcastMeetingPolicy.md b/skype/skype-ps/skype/Grant-CsBroadcastMeetingPolicy.md deleted file mode 100644 index 5758aa5264..0000000000 --- a/skype/skype-ps/skype/Grant-CsBroadcastMeetingPolicy.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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-CsClientPolicy.md b/skype/skype-ps/skype/Grant-CsClientPolicy.md index c136da040f..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Grant-CsConferencingPolicy.md b/skype/skype-ps/skype/Grant-CsConferencingPolicy.md index ecf283545c..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md b/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md index 5819cb7b84..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://learn.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 +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] [] ``` @@ -126,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 @@ -239,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).` diff --git a/skype/skype-ps/skype/Grant-CsGraphPolicy.md b/skype/skype-ps/skype/Grant-CsGraphPolicy.md index a0066b973d..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://learn.microsoft.com/powershell/module/skype/grant-csgraphpolicy -applicable: Microsoft Teams, Skype for Business Online +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 diff --git a/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md b/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md index 09b84a86c1..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://learn.microsoft.com/powershell/module/skype/grant-csipphonepolicy -applicable: Microsoft Teams, Skype for Business Online +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 diff --git a/skype/skype-ps/skype/Grant-CsMobilityPolicy.md b/skype/skype-ps/skype/Grant-CsMobilityPolicy.md index 2404835b73..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md b/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md index e778460f46..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://learn.microsoft.com/powershell/module/skype/grant-cspersistentchatpolicy -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Grant-CsPersistentChatPolicy schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md index f9d630f26d..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://learn.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy -applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 +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| |---|---|---|---| @@ -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://learn.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 diff --git a/skype/skype-ps/skype/Grant-CsVoicePolicy.md b/skype/skype-ps/skype/Grant-CsVoicePolicy.md index d9529153fc..f553602f84 100644 --- a/skype/skype-ps/skype/Grant-CsVoicePolicy.md +++ b/skype/skype-ps/skype/Grant-CsVoicePolicy.md @@ -229,5 +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 56d4270c80..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Import-CsOrganizationalAutoAttendantHolidays.md b/skype/skype-ps/skype/Import-CsOrganizationalAutoAttendantHolidays.md deleted file mode 100644 index f340718b7f..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://learn.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 fbd10e8132..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://learn.microsoft.com/powershell/module/skype/import-cspersistentchatdata -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Import-CsPersistentChatData schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Invoke-CsPoolFailOver.md b/skype/skype-ps/skype/Invoke-CsPoolFailOver.md index 6d0a97ae2f..45d8e8e11f 100644 --- a/skype/skype-ps/skype/Invoke-CsPoolFailOver.md +++ b/skype/skype-ps/skype/Invoke-CsPoolFailOver.md @@ -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. diff --git a/skype/skype-ps/skype/Invoke-CsUcsRollback.md b/skype/skype-ps/skype/Invoke-CsUcsRollback.md index 07802a0d8f..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://learn.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 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Invoke-CsUcsRollback schema: 2.0.0 manager: bulenteg diff --git a/skype/skype-ps/skype/Move-CsMeetingRoom.md b/skype/skype-ps/skype/Move-CsMeetingRoom.md index f33b23e746..25aefd9c8e 100644 --- a/skype/skype-ps/skype/Move-CsMeetingRoom.md +++ b/skype/skype-ps/skype/Move-CsMeetingRoom.md @@ -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. diff --git a/skype/skype-ps/skype/Move-CsRgsConfiguration.md b/skype/skype-ps/skype/Move-CsRgsConfiguration.md index d2ed58c96f..c0b6514042 100644 --- a/skype/skype-ps/skype/Move-CsRgsConfiguration.md +++ b/skype/skype-ps/skype/Move-CsRgsConfiguration.md @@ -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. diff --git a/skype/skype-ps/skype/Move-CsUser.md b/skype/skype-ps/skype/Move-CsUser.md index db7f4def96..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://learn.microsoft.com/powershell/module/skype/move-csuser -applicable: 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 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 @@ -44,13 +53,16 @@ When moving a user to the Microsoft 365 cloud to become TeamsOnly (or the revers - 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 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 complte 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). +- 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 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) automatcically use OAuth, so this switch is no longer required. +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 @@ -452,7 +431,7 @@ Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.ADConnect [Move users between on-premises and cloud](https://learn.microsoft.com/skypeforbusiness/hybrid/move-users-between-on-premises-and-cloud) -[Skype for Business Hybrid Solutions](https://learn.microsoft.com/SkypeForBusiness/skype-for-business-hybrid-solutions/skype-for-business-hybrid-solutions) +[Configure Skype for Business hybrid](https://learn.microsoft.com/SkypeForBusiness/hybrid/configure-federation-with-skype-for-business-online) [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/New-CsAutodiscoverConfiguration.md b/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md index aac7c2ce62..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://learn.microsoft.com/powershell/module/skype/new-csautodiscoverconfiguration -applicable: 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 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}. diff --git a/skype/skype-ps/skype/New-CsCallQueue.md b/skype/skype-ps/skype/New-CsCallQueue.md deleted file mode 100644 index 6d0c67e625..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://learn.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-CsClientPolicy.md b/skype/skype-ps/skype/New-CsClientPolicy.md index bb30cbed5d..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://learn.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 +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,7 +1353,7 @@ 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: +To convert a binary number to a decimal number, you can use a Windows PowerShell command similar to this: `[Convert]::ToInt32("1110111", 2)` diff --git a/skype/skype-ps/skype/New-CsConferencingPolicy.md b/skype/skype-ps/skype/New-CsConferencingPolicy.md index b06a18849b..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://learn.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, +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 diff --git a/skype/skype-ps/skype/New-CsExternalAccessPolicy.md b/skype/skype-ps/skype/New-CsExternalAccessPolicy.md index dbe4bdc302..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://learn.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 +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] [] ``` @@ -51,7 +52,7 @@ This enables your users to use Skype for Business and log on to Skype for Busine 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. @@ -97,8 +98,6 @@ $x = New-CsExternalAccessPolicy -Identity RedmondAccessPolicy -InMemory $x.EnableFederationAccess = $True -$x.EnablePublicCloudAccess = $True - $x.EnableOutsideAccess = $True Set-CsExternalAccessPolicy -Instance $x @@ -108,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. @@ -129,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 @@ -146,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 @@ -164,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 @@ -185,7 +184,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 Position: Named @@ -195,7 +194,7 @@ 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. @@ -205,7 +204,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 Position: Named @@ -215,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. @@ -224,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 @@ -240,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 @@ -250,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. @@ -275,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 @@ -291,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 @@ -308,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 @@ -357,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 @@ -380,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 diff --git a/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md index 3efc6c10fd..728455d346 100644 --- a/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md @@ -7,7 +7,7 @@ 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 diff --git a/skype/skype-ps/skype/New-CsHuntGroup.md b/skype/skype-ps/skype/New-CsHuntGroup.md deleted file mode 100644 index c9466b369e..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://learn.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 c607071bd5..55b09cfd15 100644 --- a/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md @@ -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://learn.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 diff --git a/skype/skype-ps/skype/New-CsHybridPSTNSite.md b/skype/skype-ps/skype/New-CsHybridPSTNSite.md index 3c26030070..7bd818bd11 100644 --- a/skype/skype-ps/skype/New-CsHybridPSTNSite.md +++ b/skype/skype-ps/skype/New-CsHybridPSTNSite.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsHybridPSTNSite diff --git a/skype/skype-ps/skype/New-CsMcxConfiguration.md b/skype/skype-ps/skype/New-CsMcxConfiguration.md index 3ad60e3214..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://learn.microsoft.com/powershell/module/skype/new-csmcxconfiguration -applicable: 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 title: New-CsMcxConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/New-CsMobilityPolicy.md b/skype/skype-ps/skype/New-CsMobilityPolicy.md index 15c7ed3a3f..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://learn.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 +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 diff --git a/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md b/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md index 4c68ec91c7..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://learn.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 +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) diff --git a/skype/skype-ps/skype/New-CsOAuthServer.md b/skype/skype-ps/skype/New-CsOAuthServer.md index 57866a6386..683832a330 100644 --- a/skype/skype-ps/skype/New-CsOAuthServer.md +++ b/skype/skype-ps/skype/New-CsOAuthServer.md @@ -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 diff --git a/skype/skype-ps/skype/New-CsOnlineApplicationEndpoint.md b/skype/skype-ps/skype/New-CsOnlineApplicationEndpoint.md deleted file mode 100644 index 7ef0201646..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineApplicationEndpoint.md +++ /dev/null @@ -1,310 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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://learn.microsoft.com/powershell/module/skype/get-csonlineapplicationendpoint) - -[Set-CsOnlineApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/set-csonlineapplicationendpoint) - -[Remove-CsOnlineApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-csonlineapplicationendpoint) - -[Set up a Trusted Application Endpoint](https://learn.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 51aa842043..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://learn.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 d1a652a421..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineAudioFile.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 269e700490..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineBulkAssignmentInput.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 49ba829b97..0000000000 --- a/skype/skype-ps/skype/New-CsOnlineNumberPortInOrder.md +++ /dev/null @@ -1,746 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 88febe26f9..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://learn.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://learn.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 87b61f15cd..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://learn.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 3ce36cd6f3..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://learn.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 095c84dcc3..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://learn.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 5bd51575aa..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://learn.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 d62e0fa1c1..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://learn.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 63d3fa521d..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://learn.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 f5373e9474..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://learn.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 88fc4819ab..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://learn.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-CsPartnerApplication.md b/skype/skype-ps/skype/New-CsPartnerApplication.md index 017432560a..60a75d1f84 100644 --- a/skype/skype-ps/skype/New-CsPartnerApplication.md +++ b/skype/skype-ps/skype/New-CsPartnerApplication.md @@ -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 -------------------------- diff --git a/skype/skype-ps/skype/New-CsPersistentChatAddin.md b/skype/skype-ps/skype/New-CsPersistentChatAddin.md index 9d4c99780f..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://learn.microsoft.com/powershell/module/skype/new-cspersistentchataddin -applicable: Lync Server 2013, Skype for Business Server 2015 +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) diff --git a/skype/skype-ps/skype/New-CsPersistentChatCategory.md b/skype/skype-ps/skype/New-CsPersistentChatCategory.md index 747aa2f83c..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://learn.microsoft.com/powershell/module/skype/new-cspersistentchatcategory -applicable: Lync Server 2013, Skype for Business Server 2015 +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 -------------------------- diff --git a/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md index 7fd23b4abd..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://learn.microsoft.com/powershell/module/skype/new-cspersistentchatcomplianceconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +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) diff --git a/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md b/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md index cf3fe97e59..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://learn.microsoft.com/powershell/module/skype/new-cspersistentchatconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +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 diff --git a/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md b/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md index 873f3c6e0f..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://learn.microsoft.com/powershell/module/skype/new-cspersistentchatendpoint -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPersistentChatEndpoint schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/New-CsPersistentChatPolicy.md b/skype/skype-ps/skype/New-CsPersistentChatPolicy.md index 730b5c64d5..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://learn.microsoft.com/powershell/module/skype/new-cspersistentchatpolicy -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPersistentChatPolicy schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/New-CsPersistentChatRoom.md b/skype/skype-ps/skype/New-CsPersistentChatRoom.md index 3dcc46f681..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://learn.microsoft.com/powershell/module/skype/new-cspersistentchatroom -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPersistentChatRoom schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/New-CsPlatformServiceSettings.md b/skype/skype-ps/skype/New-CsPlatformServiceSettings.md index 4d9b3f078e..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://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsPlatformServiceSettings schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md b/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md index 171d793868..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://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration -applicable: 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 title: New-CsPushNotificationConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/New-CsReportingConfiguration.md b/skype/skype-ps/skype/New-CsReportingConfiguration.md index f269b620ee..5b76d057c5 100644 --- a/skype/skype-ps/skype/New-CsReportingConfiguration.md +++ b/skype/skype-ps/skype/New-CsReportingConfiguration.md @@ -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 diff --git a/skype/skype-ps/skype/New-CsRgsWorkflow.md b/skype/skype-ps/skype/New-CsRgsWorkflow.md index 33f202b6cc..dd48bcbd80 100644 --- a/skype/skype-ps/skype/New-CsRgsWorkflow.md +++ b/skype/skype-ps/skype/New-CsRgsWorkflow.md @@ -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) diff --git a/skype/skype-ps/skype/New-CsServerApplication.md b/skype/skype-ps/skype/New-CsServerApplication.md index 31b2c32c76..00a0588174 100644 --- a/skype/skype-ps/skype/New-CsServerApplication.md +++ b/skype/skype-ps/skype/New-CsServerApplication.md @@ -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 diff --git a/skype/skype-ps/skype/New-CsSimpleUrl.md b/skype/skype-ps/skype/New-CsSimpleUrl.md index 9e390f0444..93d388cd74 100644 --- a/skype/skype-ps/skype/New-CsSimpleUrl.md +++ b/skype/skype-ps/skype/New-CsSimpleUrl.md @@ -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}. diff --git a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md deleted file mode 100644 index 7abb9f88c7..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://learn.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-CsTeamsEmergencyCallingPolicy.md b/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md deleted file mode 100644 index 3a3763e90f..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://learn.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 48d292f93f..0000000000 --- a/skype/skype-ps/skype/New-CsTeamsMessagingPolicy.md +++ /dev/null @@ -1,429 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 ] [-AllowSmartCompose] ] - ``` - -## 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 -``` - -### -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 -``` - -## 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 91c072c2ac..e0076883f9 100644 --- a/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md @@ -2,7 +2,7 @@ external help file: Microsoft.Rtc.Management.dll-Help.xml Module Name: SkypeForBusiness online version: https://learn.microsoft.com/powershell/module/skype/new-csteamsupgradepolicy -applicable: Skype for Business Server 2019 +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsTeamsUpgradePolicy schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/New-CsTenantNetworkRegion.md b/skype/skype-ps/skype/New-CsTenantNetworkRegion.md deleted file mode 100644 index abb2305c57..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://learn.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 18e9907835..11a5b21e8e 100644 --- a/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # New-CsTenantUpdateTimeWindow diff --git a/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md b/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md index 928b69fd37..554d14112c 100644 --- a/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md @@ -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. diff --git a/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md b/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md index 94f6d69abd..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://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, Microsoft Teams +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-CsVoiceRegex.md b/skype/skype-ps/skype/New-CsVoiceRegex.md index e35a7a0536..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://learn.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 +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 diff --git a/skype/skype-ps/skype/New-CsWebLink.md b/skype/skype-ps/skype/New-CsWebLink.md index ea2b29a5cb..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://learn.microsoft.com/powershell/module/skype/new-csweblink -applicable: 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 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}. diff --git a/skype/skype-ps/skype/New-CsWebOrigin.md b/skype/skype-ps/skype/New-CsWebOrigin.md index 15060adbc4..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://learn.microsoft.com/powershell/module/skype/new-csweborigin -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsWebOrigin schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/New-CsXmppAllowedPartner.md b/skype/skype-ps/skype/New-CsXmppAllowedPartner.md index 472968c6e7..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://learn.microsoft.com/powershell/module/skype/new-csxmppallowedpartner -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: New-CsXmppAllowedPartner schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md b/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md index 983e934028..9dcace377f 100644 --- a/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Register-CsHybridPSTNAppliance diff --git a/skype/skype-ps/skype/Remove-CsApplicationAccessPolicy.md b/skype/skype-ps/skype/Remove-CsApplicationAccessPolicy.md deleted file mode 100644 index 4d92ea93e5..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://learn.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-CsAutodiscoverConfiguration.md b/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md index e5d8a74c1d..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://learn.microsoft.com/powershell/module/skype/remove-csautodiscoverconfiguration -applicable: 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 title: Remove-CsAutodiscoverConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsClientPolicy.md b/skype/skype-ps/skype/Remove-CsClientPolicy.md index 44099a6b21..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Remove-CsConferencingPolicy.md b/skype/skype-ps/skype/Remove-CsConferencingPolicy.md index 6b87427450..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md b/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md index e5e6416cb0..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://learn.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 +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,7 +14,7 @@ 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 @@ -36,7 +36,9 @@ External access policies can grant (or revoke) the ability of your users to do a 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. @@ -107,7 +109,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: True @@ -123,7 +125,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 @@ -178,7 +180,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 diff --git a/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md index 5dbfdbb16e..a7a6576fd6 100644 --- a/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsExternalUserCommunicationPolicy diff --git a/skype/skype-ps/skype/Remove-CsHuntGroup.md b/skype/skype-ps/skype/Remove-CsHuntGroup.md deleted file mode 100644 index 54c4c91aa4..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://learn.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-CsHybridPSTNSite.md b/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md index c2ef2939f2..57891ebc8e 100644 --- a/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md +++ b/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsHybridPSTNSite diff --git a/skype/skype-ps/skype/Remove-CsMcxConfiguration.md b/skype/skype-ps/skype/Remove-CsMcxConfiguration.md index df8587bad7..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://learn.microsoft.com/powershell/module/skype/remove-csmcxconfiguration -applicable: 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 title: Remove-CsMcxConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsMobilityPolicy.md b/skype/skype-ps/skype/Remove-CsMobilityPolicy.md index c486ad30a7..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Remove-CsOnlineApplicationEndpoint.md b/skype/skype-ps/skype/Remove-CsOnlineApplicationEndpoint.md deleted file mode 100644 index 1cb1c90555..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://learn.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://learn.microsoft.com/powershell/module/skype/set-csonlineapplicationendpoint) - -[New-CsOnlineApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-csonlineapplicationendpoint) - -[Get-CsOnlineApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/get-csonlineapplicationendpoint) - -[Set up a Trusted Application Endpoint](https://learn.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 a39d6be212..0000000000 --- a/skype/skype-ps/skype/Remove-CsOnlineNumberPortInOrder.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 2f29f9edd2..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://learn.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-CsPersistentChatAddin.md b/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md index 6814efcfec..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://learn.microsoft.com/powershell/module/skype/remove-cspersistentchataddin -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPersistentChatAddin schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md b/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md index ed6b052d8c..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://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatcategory -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPersistentChatCategory schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md index bb94e57370..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://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatcomplianceconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2015 title: Remove-CsPersistentChatComplianceConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md b/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md index 447456f7bc..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://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPersistentChatConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md b/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md index 03a40d29a3..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://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatmessage -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPersistentChatMessage schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md b/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md index e662ab45c5..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://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatroom -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPersistentChatRoom schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md b/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md index 4b8084f2cb..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://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsPlatformServiceSettings schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md b/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md index 397a2985c8..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://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration -applicable: 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 title: Remove-CsPushNotificationConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsReportingConfiguration.md b/skype/skype-ps/skype/Remove-CsReportingConfiguration.md index 4627e99af8..f39a678c24 100644 --- a/skype/skype-ps/skype/Remove-CsReportingConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsReportingConfiguration.md @@ -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. diff --git a/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md b/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md index 28699e1729..4d7b1655df 100644 --- a/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md @@ -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. diff --git a/skype/skype-ps/skype/Remove-CsSlaConfiguration.md b/skype/skype-ps/skype/Remove-CsSlaConfiguration.md index 743334f5e1..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://learn.microsoft.com/powershell/module/skype/remove-csslaconfiguration -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsSlaConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsSlaDelegates.md b/skype/skype-ps/skype/Remove-CsSlaDelegates.md index fcdc2ad4a9..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://learn.microsoft.com/powershell/module/skype/remove-cssladelegates -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsSlaDelegates schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md index 673fbcc6ab..f8d9052ec0 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md @@ -2,7 +2,7 @@ external help file: Microsoft.Rtc.Management.dll-Help.xml Module Name: SkypeForBusiness online version: https://learn.microsoft.com/powershell/module/skype/remove-csteamsupgradepolicy -applicable: Skype for Business Server 2019 +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsTeamsUpgradePolicy schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md b/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md index 020a7d292c..0927a0240a 100644 --- a/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsTenantUpdateTimeWindow diff --git a/skype/skype-ps/skype/Remove-CsUserAcp.md b/skype/skype-ps/skype/Remove-CsUserAcp.md index cca673b698..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md b/skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md index c72fb5a49a..820a5f657f 100644 --- a/skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md @@ -28,7 +28,7 @@ The VIS is a service that runs on a standalone pool and cannot be co-located on 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. diff --git a/skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md b/skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md index 59c497e7f1..fabbb2d393 100644 --- a/skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md +++ b/skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml online version: https://learn.microsoft.com/powershell/module/skype/remove-csxmppallowedpartner -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Remove-CsXmppAllowedPartner schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Request-CsCertificate.md b/skype/skype-ps/skype/Request-CsCertificate.md index a02c52007d..56a2d03fd8 100644 --- a/skype/skype-ps/skype/Request-CsCertificate.md +++ b/skype/skype-ps/skype/Request-CsCertificate.md @@ -98,7 +98,7 @@ Example 3 uses the Output parameter to create an offline certificate request. ### -------------------------- Example 4 ----------------------- ``` -Request-CsCertificate -New -Type Default,WebServicesInternal,WebServicesExternal -ComputerFqdn "atl-cs-001.litwareinc.com" -CA "atl-ca-001.litwareinc.com\myca" -FriendlyName "Standard Edition Certficate" -Template jcila -PrivateKeyExportable $True -DomainName "atl-cs-001.litwareinc.com,atl-ext.litwareinc.com" +Request-CsCertificate -New -Type Default,WebServicesInternal,WebServicesExternal -ComputerFqdn "atl-cs-001.litwareinc.com" -CA "atl-ca-001.litwareinc.com\myca" -FriendlyName "Standard Edition Certificate" -Template jcila -PrivateKeyExportable $True -DomainName "atl-cs-001.litwareinc.com,atl-ext.litwareinc.com" ``` Example 4 is a more detailed (and more realistic) example of how to use the `Request-CsCertificate` cmdlet. diff --git a/skype/skype-ps/skype/Search-CsOnlineTelephoneNumberInventory.md b/skype/skype-ps/skype/Search-CsOnlineTelephoneNumberInventory.md deleted file mode 100644 index 8cae22679d..0000000000 --- a/skype/skype-ps/skype/Search-CsOnlineTelephoneNumberInventory.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/search-csonlinetelephonenumberinventory -applicable: Skype for Business Online -title: Search-CsOnlineTelephoneNumberInventory -schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: ---- - -# Search-CsOnlineTelephoneNumberInventory - -## SYNOPSIS -Use the `Search-CsOnlineTelephoneNumberInventory` cmdlet to reserve a telephone numbers that are in inventory and available to be acquired. - -**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://learn.microsoft.com/powershell/module/teams/new-csonlinetelephonenumberorder?view=teams-ps). - -## SYNTAX - -``` -Search-CsOnlineTelephoneNumberInventory [-Tenant ] -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 aec278c10e..0000000000 --- a/skype/skype-ps/skype/Select-CsOnlineTelephoneNumberInventory.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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://learn.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-CsApplicationAccessPolicy.md b/skype/skype-ps/skype/Set-CsApplicationAccessPolicy.md deleted file mode 100644 index 4cb6b8f713..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://learn.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://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 -``` - -## 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-CsAutodiscoverConfiguration.md b/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md index afec24cd6d..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://learn.microsoft.com/powershell/module/skype/set-csautodiscoverconfiguration -applicable: 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 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-CsBroadcastMeetingConfiguration.md b/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md index e24206e363..62a74c0304 100644 --- a/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsBroadcastMeetingConfiguration diff --git a/skype/skype-ps/skype/Set-CsCallQueue.md b/skype/skype-ps/skype/Set-CsCallQueue.md deleted file mode 100644 index bc7824f1b7..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://learn.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://learn.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://learn.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-CsCceApplianceConfigurationReplicationStatus.md b/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md index ec68efb2ad..4d556a212d 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md +++ b/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsCceApplianceConfigurationReplicationStatus diff --git a/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md b/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md index 75303ad06b..1ca389b8ab 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md +++ b/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsCceApplianceDeploymentStatus diff --git a/skype/skype-ps/skype/Set-CsCceApplianceStatus.md b/skype/skype-ps/skype/Set-CsCceApplianceStatus.md index ee16419df9..634a66015e 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceStatus.md +++ b/skype/skype-ps/skype/Set-CsCceApplianceStatus.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsCceApplianceStatus diff --git a/skype/skype-ps/skype/Set-CsClientPolicy.md b/skype/skype-ps/skype/Set-CsClientPolicy.md index e3777037ce..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Set-CsConferenceServer.md b/skype/skype-ps/skype/Set-CsConferenceServer.md index 1a56397e3a..b10649feaa 100644 --- a/skype/skype-ps/skype/Set-CsConferenceServer.md +++ b/skype/skype-ps/skype/Set-CsConferenceServer.md @@ -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 diff --git a/skype/skype-ps/skype/Set-CsConferencingPolicy.md b/skype/skype-ps/skype/Set-CsConferencingPolicy.md index ebe6b02503..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md b/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md index 56d1d84701..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://learn.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 +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,6 +12,9 @@ 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. @@ -22,15 +25,14 @@ This cmdlet was introduced in Lync Server 2010. ### 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] [] ``` @@ -56,7 +58,7 @@ This enables your users to use Skype for Business and log on to Skype for Busine 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. @@ -87,23 +89,12 @@ Get-CsExternalAccessPolicy -Filter tag:* | Set-CsExternalAccessPolicy -EnableFed ``` 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 ``` @@ -133,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 @@ -149,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 @@ -166,7 +157,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 @@ -184,7 +175,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 @@ -195,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. @@ -204,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 @@ -213,25 +206,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 will be disabled any time a user is communicating with a public Internet connectivity contact. @@ -240,7 +214,7 @@ 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 @@ -261,7 +235,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 @@ -282,7 +256,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 @@ -298,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 @@ -347,7 +321,7 @@ 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 @@ -364,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 diff --git a/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md index ce36b8bcc2..58dfe5fefc 100644 --- a/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsExternalUserCommunicationPolicy diff --git a/skype/skype-ps/skype/Set-CsHuntGroup.md b/skype/skype-ps/skype/Set-CsHuntGroup.md deleted file mode 100644 index 3e7196d4de..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://learn.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 594eff675c..33c98d57dc 100644 --- a/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md @@ -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://learn.microsoft.com/powershell/module/skype/get-csonlineapplicationendpoint) - -[New-CsOnlineApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/new-csonlineapplicationendpoint) - -[Remove-CsOnlineApplicationEndpoint](https://learn.microsoft.com/powershell/module/skype/remove-csonlineapplicationendpoint) - -[Set up a Trusted Application Endpoint](https://learn.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 9e6bc4282d..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) -and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. - -## 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 has been 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 e7f2639eb6..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineDirectoryUser.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 3d9be3c1f9..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineNumberPortInOrder.md +++ /dev/null @@ -1,506 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 8d9dc7c16a..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineNumberPortOutOrderPin.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 0e0d586743..0000000000 --- a/skype/skype-ps/skype/Set-CsOnlineVoiceUserBulk.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 db16f6ccf6..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://learn.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-CsPersistentChatActiveServer.md b/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md index 96adff60ef..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://learn.microsoft.com/powershell/module/skype/set-cspersistentchatactiveserver -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatActiveServer schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Set-CsPersistentChatAddin.md b/skype/skype-ps/skype/Set-CsPersistentChatAddin.md index ea5f595161..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://learn.microsoft.com/powershell/module/skype/set-cspersistentchataddin -applicable: Lync Server 2013, Skype for Business Server 2015 +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 diff --git a/skype/skype-ps/skype/Set-CsPersistentChatCategory.md b/skype/skype-ps/skype/Set-CsPersistentChatCategory.md index 22acd050c4..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://learn.microsoft.com/powershell/module/skype/set-cspersistentchatcategory -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatCategory schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md index c1d7f67868..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://learn.microsoft.com/powershell/module/skype/set-cspersistentchatcomplianceconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatComplianceConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md b/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md index c06ad9c2c3..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://learn.microsoft.com/powershell/module/skype/set-cspersistentchatconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2015 title: Set-CsPersistentChatConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md b/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md index 1ae8fc03b0..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://learn.microsoft.com/powershell/module/skype/set-cspersistentchatpolicy -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatPolicy schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Set-CsPersistentChatRoom.md b/skype/skype-ps/skype/Set-CsPersistentChatRoom.md index b15ac20d33..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://learn.microsoft.com/powershell/module/skype/set-cspersistentchatroom -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatRoom schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Set-CsPersistentChatState.md b/skype/skype-ps/skype/Set-CsPersistentChatState.md index 436fa6dd2b..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://learn.microsoft.com/powershell/module/skype/set-cspersistentchatstate -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsPersistentChatState schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md b/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md index 98ad4ef969..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://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +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 diff --git a/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md b/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md index 7c1fcb3b82..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md b/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md index df3e6f7b9d..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Set-CsReportingConfiguration.md b/skype/skype-ps/skype/Set-CsReportingConfiguration.md index ac1d680398..9e96050de2 100644 --- a/skype/skype-ps/skype/Set-CsReportingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsReportingConfiguration.md @@ -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 diff --git a/skype/skype-ps/skype/Set-CsServerApplication.md b/skype/skype-ps/skype/Set-CsServerApplication.md index fb719e4a32..96b56c6e53 100644 --- a/skype/skype-ps/skype/Set-CsServerApplication.md +++ b/skype/skype-ps/skype/Set-CsServerApplication.md @@ -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 diff --git a/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md b/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md index d0fb5dcbce..c34fbf16bf 100644 --- a/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md @@ -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. diff --git a/skype/skype-ps/skype/Set-CsSlaConfiguration.md b/skype/skype-ps/skype/Set-CsSlaConfiguration.md index c10c3004f3..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://learn.microsoft.com/powershell/module/skype/set-csslaconfiguration -applicable: Skype for Business Server 2015, Skype for Business Server 2019 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsSlaConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md deleted file mode 100644 index 0f8f76d915..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://learn.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 dc4c54baed..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://learn.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 98020b2971..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://learn.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 -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 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 2a1e6db911..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://learn.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-CsTeamsUpgradeConfiguration.md b/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md index 0b09d153de..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://learn.microsoft.com/powershell/module/skype/set-csteamsupgradeconfiguration -applicable: Skype for Business Online +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 diff --git a/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md b/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md index cad430c2c6..86e0f3e376 100644 --- a/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md @@ -2,7 +2,7 @@ external help file: Microsoft.Rtc.Management.dll-Help.xml Module Name: SkypeForBusiness online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsupgradepolicy -applicable: Skype for Business Server 2019 +applicable: Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsTeamsUpgradePolicy schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Set-CsTenantDialPlan.md b/skype/skype-ps/skype/Set-CsTenantDialPlan.md deleted file mode 100644 index 380e2686f9..0000000000 --- a/skype/skype-ps/skype/Set-CsTenantDialPlan.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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://learn.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://learn.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 802ea962df..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://learn.microsoft.com/powershell/module/skype/set-cstenanthybridconfiguration -applicable: Skype for Business Online +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 diff --git a/skype/skype-ps/skype/Set-CsTenantNetworkRegion.md b/skype/skype-ps/skype/Set-CsTenantNetworkRegion.md deleted file mode 100644 index 82d1ff5204..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://learn.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 2558562b67..0000000000 --- a/skype/skype-ps/skype/Set-CsTenantPublicProvider.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 d911b2ffc8..16213f56b6 100644 --- a/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsTenantUpdateTimeWindow diff --git a/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md b/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md index bd4a1d183f..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Set-CsUser.md b/skype/skype-ps/skype/Set-CsUser.md index 85fa4fe98e..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://learn.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 +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 has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. +**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 has been 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**: It is not required to set this parameter 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 has been 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 ed2794951d..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://learn.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 +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 diff --git a/skype/skype-ps/skype/Set-CsUserDelegates.md b/skype/skype-ps/skype/Set-CsUserDelegates.md index e09a82499f..51ab7a0a53 100644 --- a/skype/skype-ps/skype/Set-CsUserDelegates.md +++ b/skype/skype-ps/skype/Set-CsUserDelegates.md @@ -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 diff --git a/skype/skype-ps/skype/Set-CsUserPstnSettings.md b/skype/skype-ps/skype/Set-CsUserPstnSettings.md index b6982631d6..92e36241ea 100644 --- a/skype/skype-ps/skype/Set-CsUserPstnSettings.md +++ b/skype/skype-ps/skype/Set-CsUserPstnSettings.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Set-CsUserPstnSettings diff --git a/skype/skype-ps/skype/Set-CsUserTeamMembers.md b/skype/skype-ps/skype/Set-CsUserTeamMembers.md index 8956496b08..ec4147db30 100644 --- a/skype/skype-ps/skype/Set-CsUserTeamMembers.md +++ b/skype/skype-ps/skype/Set-CsUserTeamMembers.md @@ -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 diff --git a/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md b/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md index 646abea65b..32c668c947 100644 --- a/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md @@ -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. diff --git a/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md b/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md index 0eef33263e..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://learn.microsoft.com/powershell/module/skype/set-csxmppallowedpartner -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsXmppAllowedPartner schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md b/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md index 656a64d15b..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://learn.microsoft.com/powershell/module/skype/set-csxmppgatewayconfiguration -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Set-CsXmppGatewayConfiguration schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Test-CsDataConference.md b/skype/skype-ps/skype/Test-CsDataConference.md index a14f4ee8d0..261a1b7fce 100644 --- a/skype/skype-ps/skype/Test-CsDataConference.md +++ b/skype/skype-ps/skype/Test-CsDataConference.md @@ -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. diff --git a/skype/skype-ps/skype/Test-CsLisConfiguration.md b/skype/skype-ps/skype/Test-CsLisConfiguration.md index c15c7b6a95..40c2654be8 100644 --- a/skype/skype-ps/skype/Test-CsLisConfiguration.md +++ b/skype/skype-ps/skype/Test-CsLisConfiguration.md @@ -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. diff --git a/skype/skype-ps/skype/Test-CsMcxConference.md b/skype/skype-ps/skype/Test-CsMcxConference.md index 918abba775..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://learn.microsoft.com/powershell/module/skype/test-csmcxconference -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 title: Test-CsMcxConference schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Test-CsMcxP2PIM.md b/skype/skype-ps/skype/Test-CsMcxP2PIM.md index 02c3b697dd..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://learn.microsoft.com/powershell/module/skype/test-csmcxp2pim -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 title: Test-CsMcxP2PIM schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Test-CsMcxPushNotification.md b/skype/skype-ps/skype/Test-CsMcxPushNotification.md index 015bae0373..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://learn.microsoft.com/powershell/module/skype/test-csmcxpushnotification -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 title: Test-CsMcxPushNotification schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Test-CsOnlineCarrierPortabilityIn.md b/skype/skype-ps/skype/Test-CsOnlineCarrierPortabilityIn.md deleted file mode 100644 index fcb5a5507d..0000000000 --- a/skype/skype-ps/skype/Test-CsOnlineCarrierPortabilityIn.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 528bfb28fe..0000000000 --- a/skype/skype-ps/skype/Test-CsOnlineLisCivicAddress.md +++ /dev/null @@ -1,370 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 48cb4efe00..0000000000 --- a/skype/skype-ps/skype/Test-CsOnlinePortabilityIn.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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-CsPersistentChatMessage.md b/skype/skype-ps/skype/Test-CsPersistentChatMessage.md index 65a6714882..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://learn.microsoft.com/powershell/module/skype/test-cspersistentchatmessage -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsPersistentChatMessage schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md b/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md index c43273a0eb..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://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, Microsoft Teams +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-CsXmppIM.md b/skype/skype-ps/skype/Test-CsXmppIM.md index f15730a024..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://learn.microsoft.com/powershell/module/skype/test-csxmppim -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Test-CsXmppIM schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md b/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md index 26c41a5cc6..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://learn.microsoft.com/powershell/module/skype/uninstall-csmirrordatabase -applicable: Lync Server 2013, Skype for Business Server 2015 +applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 title: Uninstall-CsMirrorDatabase schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md b/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md index d5f600f663..458d44b4aa 100644 --- a/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md @@ -7,7 +7,7 @@ schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Unregister-CsHybridPSTNAppliance diff --git a/skype/skype-ps/skype/Update-CsAdminRole.md b/skype/skype-ps/skype/Update-CsAdminRole.md index 6ccca5c7ef..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://learn.microsoft.com/powershell/module/skype/update-csadminrole -applicable: 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 title: Update-CsAdminRole schema: 2.0.0 manager: rogupta diff --git a/skype/skype-ps/skype/Update-CsOrganizationalAutoAttendant.md b/skype/skype-ps/skype/Update-CsOrganizationalAutoAttendant.md deleted file mode 100644 index 9bcb12179e..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://learn.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 3616246e56..03dc67a577 100644 --- a/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md +++ b/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md @@ -7,7 +7,7 @@ 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/skype.md b/skype/skype-ps/skype/skype.md index a1c3af3dea..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://learn.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://learn.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 2bf3b0dddd..44cc42e8b1 100644 --- a/spmt/docfx.json +++ b/spmt/docfx.json @@ -66,6 +66,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "uhfHeaderId": "MSDocsHeader-M365-IT", "author": "serdarsoysal", "ms.author": "serdars", "manager": "serdars", @@ -76,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 acb5ff487b..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." --- 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/Register-SPMTMigration.md b/spmt/spmt-ps/spmt/Register-SPMTMigration.md index 7ce429b662..f092abf2ef 100644 --- a/spmt/spmt-ps/spmt/Register-SPMTMigration.md +++ b/spmt/spmt-ps/spmt/Register-SPMTMigration.md @@ -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/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 abae7fac0f..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://learn.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/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/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 7366b0289b..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://learn.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 60bfc36c6a..dcc55539d1 100644 --- a/teams/teams-ps/teams/Add-TeamChannelUser.md +++ b/teams/teams-ps/teams/Add-TeamChannelUser.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/add-teamchanneluser +title: Add-TeamChannelUser schema: 2.0.0 --- @@ -10,9 +11,9 @@ 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 @@ -40,7 +41,7 @@ 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 2 +### Example 3 ``` Add-TeamChannelUser -GroupId 31f1ff6c-d48c-4f8a-b2e1-abca7fd399df -DisplayName "Engineering" -User 0e4249a7-6cfd-8c93-a510-91cda44c8c73 -TenantId dcd143cb-c4ae-4364-9faf-e1c3242bf4ff ``` diff --git a/teams/teams-ps/teams/Add-TeamUser.md b/teams/teams-ps/teams/Add-TeamUser.md index 8361c17035..91f29ce8bb 100644 --- a/teams/teams-ps/teams/Add-TeamUser.md +++ b/teams/teams-ps/teams/Add-TeamUser.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 689b31e8c8..031a1aa094 100644 --- a/teams/teams-ps/teams/Add-TeamsAppInstallation.md +++ b/teams/teams-ps/teams/Add-TeamsAppInstallation.md @@ -2,10 +2,8 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 @@ -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 c44b84a194..36eee8cbf2 100644 --- a/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/teams/Clear-CsOnlineTelephoneNumberOrder.md @@ -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) +[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 7f9736fa69..8e367470c6 100644 --- a/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/teams/Complete-CsOnlineTelephoneNumberOrder.md @@ -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 8a9e6f954d..c713e2275a 100644 --- a/teams/teams-ps/teams/Connect-MicrosoftTeams.md +++ b/teams/teams-ps/teams/Connect-MicrosoftTeams.md @@ -2,6 +2,7 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: 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,60 +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] -[] +Connect-MicrosoftTeams +-TenantId +-Certificate +-ApplicationId +[-LogLevel ] +[-LogFilePath ] +[-WhatIf] +[-Confirm] +[] ``` ### ServicePrincipalCertificateThumbprint ``` -Connect-MicrosoftTeams --TenantId --CertificateThumbprint --ApplicationId -[-LogLevel ] -[-LogFilePath ] -[-WhatIf] -[-Confirm] -[] +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. -**Note**: With versions 4.x.x or later, enablement of basic authentication is not needed anymore in commercial environments. For GCC High/DoD environments and customers that are, or have previously been enabled for Regionally Hosted Meetings in Skype for Business Online, basic authentication needs to be enabled for *-Cs cmdlets to function properly. +**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 @@ -79,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 ``` @@ -90,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 ``` @@ -100,20 +102,20 @@ 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 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](/MicrosoftTeams/teams-powershell-application-authentication). +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](/MicrosoftTeams/teams-powershell-application-authentication). +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) @@ -123,36 +125,36 @@ Connect-MicrosoftTeams -Certificate $cert -ApplicationId "00000000-0000-0000-000 ### 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](/MicrosoftTeams/teams-powershell-application-authentication). +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 -} +$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 +$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 -} +$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 +$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. +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. @@ -161,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 @@ -183,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 ``` @@ -193,23 +199,23 @@ user@contoso.com AzureCloud xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx xxxxx ### AccessTokens 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](/MicrosoftTeams/teams-powershell-application-authentication). +- 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. +- Delegated flow - The 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. + 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 MS Graph, and then select Delegated Permission. - 7. Add the following permissions: "AppCatalog.ReadWrite.All", "Group.ReadWrite.All", "User.Read.All"; + 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". - 11. Add all the listed permissions. - 12. Grant admin consent to both MS Graph and "Skype and Teams Tenant Admin API" name. + 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[] @@ -222,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. @@ -253,9 +259,9 @@ Accept wildcard characters: False ``` ### -ApplicationId -Specifies the application ID of the service principal that is used in application-based authentication. +Specifies the application ID of the service principal that is used in application-based authentication. -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](/MicrosoftTeams/teams-powershell-application-authentication). +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 @@ -271,7 +277,7 @@ Accept wildcard characters: False ### -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](/MicrosoftTeams/teams-powershell-application-authentication). +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 @@ -288,7 +294,7 @@ 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](/MicrosoftTeams/teams-powershell-application-authentication). +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 @@ -348,7 +354,7 @@ Accept wildcard characters: False ``` ### -LogLevel -Specifies the log level. +Specifies the log level. The acceptable values for this parameter are: - Info @@ -430,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 @@ -446,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 @@ -501,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 78% rename from skype/skype-ps/skype/Disable-CsOnlineSipDomain.md rename to teams/teams-ps/teams/Disable-CsOnlineSipDomain.md index 63bfff32e0..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://learn.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 @@ -31,13 +31,13 @@ This cmdlet facilitates consolidation of multiple Skype for Business Server depl - There must be at most 1 O365 tenant involved. Consolidation in 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 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://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 fdf6329236..84d184eb9d 100644 --- a/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md +++ b/teams/teams-ps/teams/Disable-CsTeamsShiftsConnectionErrorReport.md @@ -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://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 2192ec754f..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://learn.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,12 +95,10 @@ The Export-CsAutoAttendantHolidays cmdlet accepts a string as the Identity param ### System.Byte[] - ## NOTES - ## RELATED LINKS -[Import-CsAutoAttendantHolidays](Import-CsAutoAttendantHolidays.md) +[Import-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/import-csautoattendantholidays) -[Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) +[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 37b5a7ccd1..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://learn.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,10 +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 97f3d59fd6..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://learn.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 index 2572161e1d..2bc7566964 100644 --- a/teams/teams-ps/teams/Get-AssociatedTeam.md +++ b/teams/teams-ps/teams/Get-AssociatedTeam.md @@ -2,9 +2,10 @@ 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: zhongxlmicrosoft -ms.author: zhongxl +author: serdarsoysal +ms.author: serdars ms.reviewer: dedaniel, robharad --- @@ -15,7 +16,7 @@ This cmdlet supports retrieving all teams associated with a user, including team ## SYNTAX ```PowerShell -Get-AssociatedTeam [-User ] +Get-AssociatedTeam [-User ] [] ``` ## DESCRIPTION @@ -76,5 +77,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-Team](Get-Team.md) -[Get-SharedWithTeam](Get-SharedWithTeam.md) +[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 90b887a71e..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://learn.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 8bdbc50082..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://learn.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 7daaccabe2..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://learn.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 2beb09f87e..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://learn.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,4 +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 1aa07af462..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://learn.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,7 +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 ab77018a3f..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://learn.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,8 +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 54dd5351c7..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://learn.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 diff --git a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md index 17389f9f91..b9a3895727 100644 --- a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md @@ -2,10 +2,11 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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-CsBatchTeamsDeploymentStatus.md b/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md index c4fce0d65f..2fdd9166f2 100644 --- a/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md +++ b/teams/teams-ps/teams/Get-CsBatchTeamsDeploymentStatus.md @@ -2,42 +2,43 @@ 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 -``` -Get-CsBatchTeamsDeploymentStatus -OrchestrationId [-WhatIf] [-Confirm] [] +```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. +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. +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) @@ -50,16 +51,35 @@ 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 +### 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) +[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 a98eb2a668..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://learn.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 4d87d119fa..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://learn.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 index dc7c94ea7b..f2b7e131f9 100644 --- a/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md +++ b/teams/teams-ps/teams/Get-CsCloudCallDataConnection.md @@ -1,6 +1,6 @@ --- external help file: MicrosoftTeams-help.xml -Module Name: microsoftteams +Module Name: MicrosoftTeams applicable: Microsoft Teams title: Get-CsCloudCallDataConnection online version: https://learn.microsoft.com/powershell/module/teams/get-cscloudcalldataconnection @@ -20,7 +20,7 @@ This cmdlet retrieves an already existing online call data connection. ## SYNTAX ```powershell -Get-CsCloudCallDataConnection +Get-CsCloudCallDataConnection [] ``` ## DESCRIPTION @@ -54,9 +54,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -The Get-CsCloudCallDataConnection cmdlet is only supported from Teams PowerShell Module versions 4.6.0 or later. +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](/skypeforbusiness/hybrid/configure-call-data-connector) -[New-CsCloudCallDataConnection](New-CsCloudCallDataConnection.md) +[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 b1cc8eab0c..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://learn.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,16 +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 041ca71716..015cc6cfd9 100644 --- a/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/teams/Get-CsGroupPolicyAssignment.md @@ -2,10 +2,8 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 a5cef18d8a..15b1d9e69b 100644 --- a/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md +++ b/teams/teams-ps/teams/Get-CsHybridTelephoneNumber.md @@ -3,11 +3,13 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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 @@ -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 353b45b49c..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://learn.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 9099ffa151..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://learn.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 56% rename from skype/skype-ps/skype/Get-CsMeetingMigrationStatus.md rename to teams/teams-ps/teams/Get-CsMeetingMigrationStatus.md index 2ff2f3e2c9..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://learn.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://learn.microsoft.com/powershell/module/skype/get-cstenantmigrationconfiguration?view=skype-ps) +[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration) -[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingtenantsettings?view=skype-ps) +[Get-CsOnlineDialInConferencingTenantSettings](https://learn.microsoft.com/powershell/module/teams/get-csonlinedialinconferencingtenantsettings) -[Start-CsExMeetingMigration](https://learn.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 03d77f2d5a..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://learn.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 40a7ef7674..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://learn.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 9eb3ef04b8..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://learn.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 96% rename from skype/skype-ps/skype/Get-CsOnlineDialInConferencingBridge.md rename to teams/teams-ps/teams/Get-CsOnlineDialInConferencingBridge.md index f1fd9a421f..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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencingbridge -applicable: Skype for Business Online +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,18 +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 97% rename from skype/skype-ps/skype/Get-CsOnlineDialInConferencingLanguagesSupported.md rename to teams/teams-ps/teams/Get-CsOnlineDialInConferencingLanguagesSupported.md index cb0c98ee15..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 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinedialinconferencinglanguagessupported -applicable: Skype for Business Online +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 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 2feac22212..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://learn.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 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 172f76d47f..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://learn.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,20 +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 ea5b7182cd..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://learn.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, +\] [-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 82% rename from skype/skype-ps/skype/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md rename to teams/teams-ps/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md index 41c4373186..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://learn.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://learn.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 a3e728336b..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://learn.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 4c3b7a23c3..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://learn.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 8098f705b6..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://learn.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 250db305fb..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://learn.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,23 +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 00abbecae2..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://learn.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 c606b1810f..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://learn.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 80% rename from skype/skype-ps/skype/Get-CsOnlinePSTNGateway.md rename to teams/teams-ps/teams/Get-CsOnlinePSTNGateway.md index 546a5051a7..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://learn.microsoft.com/powershell/module/skype/get-csonlinepstngateway +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinepstngateway applicable: Microsoft Teams title: Get-CsOnlinePSTNGateway schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -78,8 +78,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -93,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 85% rename from skype/skype-ps/skype/Get-CsOnlinePstnUsage.md rename to teams/teams-ps/teams/Get-CsOnlinePstnUsage.md index a981c8bcce..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://learn.microsoft.com/powershell/module/skype/get-csonlinepstnusage +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinepstnusage applicable: Microsoft Teams title: Get-CsOnlinePstnUsage schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -74,8 +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,4 +87,4 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Set-CsOnlinePstnUsage](set-csonlinepstnusage.md) +[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 ccd5f64eb5..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://learn.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 83% rename from skype/skype-ps/skype/Get-CsOnlineSipDomain.md rename to teams/teams-ps/teams/Get-CsOnlineSipDomain.md index 4d6187b20b..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://learn.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 @@ -49,7 +49,7 @@ A specific domain to get the status of. Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -65,7 +65,7 @@ Type: DomainStatus Parameter Sets: (All) Aliases: Accepted values: All, Enabled, Disabled -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -74,8 +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 @@ -89,8 +88,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[Disable-CsOnlineSipDomain](Disable-CsOnlineSipDomain.md) +[Disable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/disable-csonlinesipdomain) -[Enable-CsOnlineSipDomain](Enable-CsOnlineSipDomain.md) +[Enable-CsOnlineSipDomain](https://learn.microsoft.com/powershell/module/teams/enable-csonlinesipdomain) [Cloud consolidation for Teams and Skype for Business](https://learn.microsoft.com/skypeforbusiness/hybrid/cloud-consolidation) diff --git a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumber.md b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md similarity index 85% rename from skype/skype-ps/skype/Get-CsOnlineTelephoneNumber.md rename to teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md index 759e8a7dd1..0fced81daf 100644 --- a/skype/skype-ps/skype/Get-CsOnlineTelephoneNumber.md +++ b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumber.md @@ -1,12 +1,12 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csonlinetelephonenumber -applicable: Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinetelephonenumber +applicable: Microsoft Teams title: Get-CsOnlineTelephoneNumber schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -15,7 +15,7 @@ ms.reviewer: ## SYNOPSIS Use the `Get-CsOnlineTelephoneNumber` to retrieve telephone numbers from the Business Voice Directory. -**Note**: This cmdlet has been deprecated. Use the new [Get-CsPhoneNumberAssignment](/powershell/module/teams/get-csphonenumberassignment) cmdlet instead. For Microsoft 365 GCC High and DoD cloud instances use the new [Get-CshybridTelephoneNumber](/powershell/module/teams/get-cshybridtelephonenumber) cmdlet instead. +**Note**: This cmdlet has been deprecated. Use the new [Get-CsPhoneNumberAssignment](https://learn.microsoft.com/powershell/module/teams/get-csphonenumberassignment) cmdlet instead. For Microsoft 365 GCC High and DoD cloud instances use the new [Get-CshybridTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/get-cshybridtelephonenumber) cmdlet instead. ## SYNTAX @@ -87,8 +87,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 @@ -110,8 +110,8 @@ The values for the Assigned parameter are case-sensitive. ```yaml Type: MultiValuedProperty Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -130,7 +130,7 @@ The values for the CapitalOrMajorCity parameter are case-sensitive. Type: String Parameter Sets: (All) Aliases: CityCode -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -146,7 +146,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 @@ -161,8 +161,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 @@ -179,8 +179,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 @@ -202,8 +202,8 @@ The values for the InventoryType parameter are case-sensitive. ```yaml Type: MultiValuedProperty Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -218,8 +218,8 @@ Specifying this switch parameter will return only telephone numbers which are no ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -236,8 +236,8 @@ If set to 0, the command will run, but no data will be returned. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -248,15 +248,15 @@ Accept wildcard characters: False ### -TelephoneNumber Specifies the target telephone number. -For example: +For example: `-TelephoneNumber tel:+18005551234, or -TelephoneNumber +14251234567` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -273,8 +273,8 @@ The telephone number should be in E.164 format. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -291,8 +291,8 @@ The telephone number should be in E.164 format. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -310,8 +310,8 @@ You can use up to nine digits. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -326,8 +326,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 @@ -337,7 +337,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 @@ -351,4 +351,4 @@ An instance or array of the objects. ## NOTES ## RELATED LINKS -[Remove-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/skype/remove-csonlinetelephonenumber?view=skype-ps) +[Remove-CsOnlineTelephoneNumber](https://learn.microsoft.com/powershell/module/teams/remove-csonlinetelephonenumber) diff --git a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md index 681dd932a9..e2731e0eed 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md +++ b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md @@ -13,7 +13,7 @@ ms.reviewer: julienp # Get-CsOnlineTelephoneNumberCountry ## SYNOPSIS -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. ## SYNTAX @@ -22,7 +22,7 @@ PS C:\> 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) +[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 fe0c1a5083..5725171ad6 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberOrder.md @@ -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) +## 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 bd7d1b6bba..47c397e14b 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md +++ b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md @@ -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) +[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..73ccb9f1c7 --- /dev/null +++ b/teams/teams-ps/teams/Get-CsOnlineUser.md @@ -0,0 +1,591 @@ +--- +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 verion 7.1.1 Preview and later**: + +- EffectivePolicyAssignments: The EffectivePolicyAssignments attribute has been added to the Get-CsOnlineUser cmdlet in commercial environments. This new attribute provides information about a user's effective policy assignments. Each assignment includes the following details: + - PolicyType - which specifies the type of policy assigned (for example, TeamsMeetingPolicy, TeamsCallingPolicy, and so on.) + - PolicyAssignment - which includes the display name of the assigned policy (displayName), the assignment type (assignmentType) indicating whether it is direct or group-based, the unique identifier of the policy (policyId), and the group identifier (groupId) if applicable. + **Note**: The policyId property isn't currently supported. + +**Updates in Teams PowerShell Module**: + +- DialPlan: DialPlan attribute will be deprecated and no longer populated in the output of Get-CsOnlineUser in all clouds. + +**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 85% rename from skype/skype-ps/skype/Get-CsOnlineVoiceRoute.md rename to teams/teams-ps/teams/Get-CsOnlineVoiceRoute.md index fc67e6c32d..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://learn.microsoft.com/powershell/module/skype/get-csonlinevoiceroute +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute applicable: Microsoft Teams title: Get-CsOnlineVoiceRoute schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -30,7 +30,7 @@ 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. @@ -97,8 +97,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 @@ -111,8 +110,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoute](new-csonlinevoiceroute.md) +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) -[Set-CsOnlineVoiceRoute](set-csonlinevoiceroute.md) +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) -[Remove-CsOnlineVoiceRoute](remove-csonlinevoiceroute.md) +[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 86% rename from skype/skype-ps/skype/Get-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/teams/Get-CsOnlineVoiceRoutingPolicy.md index 2bc63e283a..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://learn.microsoft.com/powershell/module/skype/get-csonlinevoiceroutingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroutingpolicy applicable: Microsoft Teams title: Get-CsOnlineVoiceRoutingPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -114,8 +114,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (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 @@ -128,10 +127,10 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsOnlineVoiceRoutingPolicy](new-csonlinevoiceroutingpolicy.md) +[New-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy) -[Set-CsOnlineVoiceRoutingPolicy](set-csonlinevoiceroutingpolicy.md) +[Set-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy) -[Grant-CsOnlineVoiceRoutingPolicy](grant-csonlinevoiceroutingpolicy.md) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](remove-csonlinevoiceroutingpolicy.md) +[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 85% rename from skype/skype-ps/skype/Get-CsOnlineVoiceUser.md rename to teams/teams-ps/teams/Get-CsOnlineVoiceUser.md index e89755b937..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://learn.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: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -24,7 +24,7 @@ Get-CsOnlineVoiceUser [-CivicAddressId ] [-DomainController < ## DESCRIPTION -**Note**: This cmdlet will be deprecated. You should start using the replacement cmdlets described here as soon as possible. +**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`. @@ -55,11 +55,11 @@ The following table lists the output fields from `Get-CsOnlineVoiceUser` and the | 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, the following improvements have been introduced for organizations using Teams: +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 @@ -68,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 @@ -88,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 @@ -97,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 @@ -114,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 @@ -132,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 @@ -148,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 @@ -165,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 @@ -185,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 @@ -198,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 @@ -221,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 @@ -244,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 @@ -261,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 @@ -277,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 @@ -293,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 @@ -313,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 @@ -333,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 @@ -351,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 @@ -369,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 @@ -381,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://learn.microsoft.com/powershell/module/skype/set-csonlinevoiceuser?view=skype-ps) - -[Set-CsOnlineVoiceUserBulk](https://learn.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 82% rename from skype/skype-ps/skype/Get-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/teams/Get-CsOnlineVoicemailPolicy.md index af9346cde4..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://learn.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://learn.microsoft.com/powershell/module/skype/set-csonlinevoicemailpolicy?view=skype-ps) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/skype/new-csonlinevoicemailpolicy?view=skype-ps) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csonlinevoicemailpolicy?view=skype-ps) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://learn.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 41d96efe97..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://learn.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,10 +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 220e5ce2f3..9b68146e1f 100644 --- a/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Get-CsPhoneNumberAssignment.md @@ -3,11 +3,12 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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,13 +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 @@ -35,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 @@ -45,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. @@ -58,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. @@ -105,6 +143,103 @@ 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 ### -ActivationState @@ -113,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 @@ -123,12 +258,27 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssignmentCategory +This parameter is used to differentiate between Primary and Private line assignment for a user. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: Applicable: Microsoft Teams Required: False @@ -140,14 +290,14 @@ 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 @@ -157,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 @@ -171,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 @@ -187,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 @@ -207,7 +387,7 @@ Filters the returned results based on the number type. Supported values are Dire ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -217,12 +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,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 @@ -269,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 @@ -285,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 @@ -301,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 @@ -316,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 @@ -331,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 @@ -353,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. @@ -368,7 +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. @@ -376,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. @@ -396,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 59499619f8..0e3330e1af 100644 --- a/teams/teams-ps/teams/Get-CsPolicyPackage.md +++ b/teams/teams-ps/teams/Get-CsPolicyPackage.md @@ -17,8 +17,8 @@ This cmdlet supports retrieving all the policy packages available on a tenant. ## SYNTAX -``` -Get-CsPolicyPackage [[-Identity] ] [] +```powershell +Get-CsPolicyPackage [[-Identity] ] -InputObject [] ``` ## DESCRIPTION @@ -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 738c8ca3f3..de8f75a2f2 100644 --- a/teams/teams-ps/teams/Get-CsTeamTemplate.md +++ b/teams/teams-ps/teams/Get-CsTeamTemplate.md @@ -5,7 +5,7 @@ online version: https://learn.microsoft.com/powershell/module/teams/get-csteamte title: Get-CsTeamTemplate author: serdarsoysal ms.author: serdars -ms.reviewer: +ms.reviewer: manager: farahf schema: 2.0.0 --- @@ -45,7 +45,7 @@ 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'. @@ -53,7 +53,7 @@ Within the universe of templates the admin's tenant has access to, returns a tem ### 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,25 +210,25 @@ 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 diff --git a/teams/teams-ps/teams/Get-CsTeamTemplateList.md b/teams/teams-ps/teams/Get-CsTeamTemplateList.md index c36d1fc2c7..c9928c4038 100644 --- a/teams/teams-ps/teams/Get-CsTeamTemplateList.md +++ b/teams/teams-ps/teams/Get-CsTeamTemplateList.md @@ -5,7 +5,7 @@ online version: https://learn.microsoft.com/powershell/module/teams/get-csteamte 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,7 +40,7 @@ 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. @@ -50,7 +50,7 @@ Note: All 1P Microsoft templates will always be returned in the specified locale ### 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. 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 4f52d88717..6ba81b228a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsAcsFederationConfiguration.md @@ -12,52 +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'} EnableAcsUsers : True ``` -### Example 2 -In this example, federation is disabled for all ACS resources. +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 : {} 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 @@ -66,10 +102,10 @@ EnableAcsUsers : False ## 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 51% rename from skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md index 4c477c5e33..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://learn.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 66% rename from skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md index 623a14b796..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://learn.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 @@ -42,7 +43,49 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ## 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 85% rename from skype/skype-ps/skype/Get-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsAudioConferencingPolicy.md index 2c9ee32b39..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://learn.microsoft.com/powershell/module/skype/get-csteamsaudioconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy +title: Get-CsTeamsAudioConferencingPolicy schema: 2.0.0 --- @@ -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 f6f8195ac1..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://learn.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 922988fea9..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://learn.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 8875e78313..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://learn.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 685c727d95..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://learn.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 6cf7d1d305..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://learn.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 87% rename from skype/skype-ps/skype/Get-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/teams/Get-CsTeamsComplianceRecordingApplication.md index 20fd444017..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://learn.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://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.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 84% rename from skype/skype-ps/skype/Get-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsComplianceRecordingPolicy.md index 4d5b0164ce..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://learn.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://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.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 ea3cc18040..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://learn.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 08e343d922..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://learn.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 index f69ab3875d..09801a74c1 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEducationConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsEducationConfiguration.md @@ -2,8 +2,8 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams title: Get-CsTeamsEducationConfiguration -author: prrathna -ms.author: prrathna +author: SaritaBehera +ms.author: saritabehera online version: https://learn.microsoft.com/powershell/module/teams/get-csteamseducationconfiguration schema: 2.0.0 --- @@ -16,31 +16,73 @@ This cmdlet is used to retrieve the organization-wide education configuration fo ## SYNTAX +### Identity (Default) ```powershell -Get-CsTeamsEducationConfiguration +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 or a Global Administrator for your organization to run the cmdlet. +You must be a Teams Service Administrator for your organization to run the cmdlet. ## Examples ### Example 1 -In this example, the organization has Email selected as the preferred contact method used for parent communication invitations. - ```powershell -Get-CsTeamsEducationConfiguration -``` -```Output +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 @@ -49,4 +91,4 @@ ParentGuardianPreferredContactMethod : Email ## RELATED LINKS -[Set-CsTeamsEducationConfiguration](Set-CsTeamsEducationConfiguration.md) +[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 bf7efa5474..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://learn.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 0b7204a44d..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://learn.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 f50098fd05..d1c2fd903d 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsEnhancedEncryptionPolicy.md @@ -3,8 +3,8 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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,20 +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) +[New-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsenhancedencryptionpolicy) -[Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-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/Get-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md index 3003491840..db497af1ae 100644 --- a/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsEventsPolicy.md @@ -2,6 +2,7 @@ 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 --- @@ -23,7 +24,7 @@ Get-CsTeamsEventsPolicy [-Filter ] [] ``` ## DESCRIPTION -Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. +Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. ## EXAMPLES @@ -34,7 +35,6 @@ 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 @@ -42,7 +42,6 @@ PS C:\> Get-CsTeamsEventsPolicy -Identity Global Returns information for Teams Events policy with identity "Global". - ## PARAMETERS ### -Filter @@ -63,7 +62,6 @@ Accept wildcard characters: False ### -Identity Unique identifier assigned to the Teams Events policy. - ```yaml Type: String Parameter Sets: Identity @@ -79,7 +77,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 ### None @@ -87,6 +84,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 f6b3b53bc7..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://learn.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 42bbd41a07..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://learn.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 5bb0bc7623..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://learn.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 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 ca87790108..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://learn.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 02b61ad14f..85ecd6cb9c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMediaLoggingPolicy.md @@ -2,7 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmedialoggingpolicy -applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams title: Get-CsTeamsMediaLoggingPolicy author: LeoKuhorev ms.author: leokukharau @@ -68,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 @@ -85,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 @@ -108,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 0181801e9a..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://learn.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 8f6493fc6e..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://learn.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 2364b2a2b8..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://learn.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 89% rename from skype/skype-ps/skype/Get-CsTeamsMeetingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsMeetingPolicy.md index e263a75569..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://learn.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 @@ -73,7 +72,6 @@ NewMeetingRecordingExpirationDays : 60 The above command returns expiration date setting currently applied on TMR. For more details, see: [Auto-expiration of Teams meeting recordings](https://learn.microsoft.com/microsoftteams/cloud-recording#auto-expiration-of-teams-meeting-recordings). - ## PARAMETERS ### -Filter @@ -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 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 9242b31efc..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://learn.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 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 bca6ba2ae1..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://learn.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 76% rename from skype/skype-ps/skype/Get-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsNetworkRoamingPolicy.md index e84b7c8506..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://learn.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 @@ -35,7 +40,7 @@ The TeamsNetworkRoamingPolicy cmdlets enable administrators to provide specific 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 f2d04607c1..b236e9c29c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md @@ -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 dc70a19d0e..adf41720e0 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionErrorReport.md @@ -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 21dbc4e5d7..9cae80f516 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md @@ -2,7 +2,7 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: Get-CsTeamsShiftsConnectionInstance -author: lespina +author: leonardospina ms.author: lespina manager: valk online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance @@ -49,85 +49,90 @@ PS C:\> Get-CsTeamsShiftsConnectionInstance | Format-List ``` ```output -ConnectorAdminEmail : {admin@contoso.com} -ConnectorId : 6A51B888-FF44-4FEA-82E1-839401E00000 -ConnectorName : WFM 1 -ConnectorSpecificSettingAdminApiUrl : https://www.contoso.com/retail/data/wfmadmin/api/v1-beta3 -ConnectorSpecificSettingApiUrl : -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 : -DesignatedActorId : 538C1F8F-320E-4C46-8109-1F08918B13ED -EnabledConnectorScenario : {Shift, SwapRequest, UserShiftPreferences, OpenShift...} -EnabledWfiScenario : {SwapRequest, OpenShiftRequest, TimeCard, TimeOffRequest} -Etag : "05004cd2-0000-0400-0000-62fbc3e10000" -Id : WCI-74710858-44EC-4BC1-B43C-B71479A232D6 -Name : My connector instance 1 -SyncFrequencyInMin : 3 -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 -WorkforceIntegrationId : WFI_0D3DCF76-F826-4416-99AC-056F83A4C9F7 - -ConnectorAdminEmail : {admin@contoso.com} -ConnectorId : 95BF2848-2DDA-4425-B0EE-D62AEED00000 -ConnectorName : WFM 2 -ConnectorSpecificSettingAdminApiUrl : -ConnectorSpecificSettingApiUrl : https://www.contoso.com/api -ConnectorSpecificSettingClientId : 86q446dXbJz6UdZeOr1FrP8chDHDZ66nu -ConnectorSpecificSettingCookieAuthUrl : -ConnectorSpecificSettingEssApiUrl : -ConnectorSpecificSettingFederatedAuthUrl : -ConnectorSpecificSettingRetailWebApiUrl : -ConnectorSpecificSettingSiteManagerUrl : -ConnectorSpecificSettingSsoUrl : https://www.contoso.com/sso -DesignatedActorId : 538C1F8F-320E-4C46-8109-1F08918B13ED -EnabledConnectorScenario : {Shift, SwapRequest, UserShiftPreferences, OpenShift...} -EnabledWfiScenario : {SwapRequest, UserShiftPreferences, OpenShiftRequest, TimeCard...} -Etag : "dd011bc0-0000-0400-0000-62f4dc450000" -Id : WCI-78F5116E-9098-45F5-B595-1153DF9D6F70 -Name : My connector instance 2 -SyncFrequencyInMin : 30 -TenantId : 3FDCAAF2-863A-4520-97BA-DFA211595876 -WorkforceIntegrationId : WFI_6E403D85-CCBA-4506-B62A-35A1D7B49E25 +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:\_\> $ci = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-78F5116E-9098-45F5-B595-1153DF9D6F70 -PS C:\_\> $ci.ToJsonString() +PS C:\> $ci = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-78F5116E-9098-45F5-B595-1153DF9D6F70 +PS C:\> $ci.ToJsonString() ``` ```output { - "connector": { - "id": "95BF2848-2DDA-4425-B0EE-D62AEED00000", - "name": "WFM 2" - }, - "connectorSpecificSettings": { - "apiUrl": "https://www.contoso.com/api", - "ssoUrl": "https://www.contoso.com/sso", - "clientId": "86q446dXbJz6UdZeOr1FrP8chDHDZ66nu" + "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": "3FDCAAF2-863A-4520-97BA-DFA211595876", - "name": "My connector instance 2", - "enabledConnectorScenarios": [ "Shift", "SwapRequest", "UserShiftPreferences", "OpenShift", "OpenShiftRequest", "TimeCard", "TimeOff", "TimeOffRequest" ], - "workforceIntegrationId": "WFI_6E403D85-CCBA-4506-B62A-35A1D7B49E25", - "enabledWfiScenarios": [ "SwapRequest", "UserShiftPreferences", "OpenShiftRequest", "TimeCard", "TimeOffRequest" ], + "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, - "designatedActorId": "538C1F8F-320E-4C46-8109-1F08918B13ED", - "connectorAdminEmails": [ "admin@contoso.com" ], - "etag": "\"dd011bc0-0000-0400-0000-62f4dc450000\"" + "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 the specified -ConnectorInstanceId. - ## PARAMETERS ### -Break @@ -267,8 +272,8 @@ 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) -[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 7aa59b2a2b..e1910f5da5 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionOperation.md @@ -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 5181e696d7..d893f5cf7e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionSyncResult.md @@ -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 99be324a01..7bdc708135 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionTeamMap.md @@ -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 @@ -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 78447acb71..f65e7c3eed 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmTeam.md @@ -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 c89812ab61..f32eda9d1a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionWfmUser.md @@ -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 9a5278bfda..05e0a5d12c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsPolicy.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 3b6d0ed441..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://learn.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 2d469c9ae8..cd8a81e96e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/teams/Get-CsTeamsUnassignedNumberTreatment.md @@ -3,11 +3,12 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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,7 +16,6 @@ schema: 2.0.0 ## SYNOPSIS Displays a specific or all treatments for how calls to an unassigned number range should be routed. - ## SYNTAX ### Identity (Default) @@ -59,7 +59,7 @@ Enables you to limit the returned data by filtering on the Identity attribute. ```yaml Type: String Parameter Sets: (Filter) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -98,8 +98,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable 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 5a07ae42f2..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://learn.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 5f58b7be5a..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://learn.microsoft.com/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,20 +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) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-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/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 6a0e0e637c..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://learn.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 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 925bbe51ab..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://learn.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,59 +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 b4e19a0748..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://learn.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,23 +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 e63f5f9ebb..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://learn.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. - -```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` +### -MsftInternalProcessingMode +For internal use only. ```yaml -Type: Guid +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -123,21 +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 82% rename from skype/skype-ps/skype/Get-CsTenantMigrationConfiguration.md rename to teams/teams-ps/teams/Get-CsTenantMigrationConfiguration.md index d864a55f79..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://learn.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://learn.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 ca6df98ebf..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://learn.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 ad4e219e46..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://learn.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 fe0079ee08..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://learn.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 35d6b6198e..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://learn.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 1371e9fb8f..43b422011c 100644 --- a/teams/teams-ps/teams/Get-CsUserCallingSettings.md +++ b/teams/teams-ps/teams/Get-CsUserCallingSettings.md @@ -3,11 +3,12 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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 44d542179f..692be05e33 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md +++ b/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md @@ -2,10 +2,11 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 0094dc223f..c0edaf3689 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyPackage.md +++ b/teams/teams-ps/teams/Get-CsUserPolicyPackage.md @@ -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 6e5a178629..ca19b2c0d9 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md +++ b/teams/teams-ps/teams/Get-CsUserPolicyPackageRecommendation.md @@ -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 d4f614a020..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://learn.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 5955648fd0..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://learn.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 index 9b4e370cae..4728ffa1b4 100644 --- a/teams/teams-ps/teams/Get-SharedWithTeam.md +++ b/teams/teams-ps/teams/Get-SharedWithTeam.md @@ -2,9 +2,10 @@ 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: zhongxlmicrosoft -ms.author: zhongxl +author: serdarsoysal +ms.author: serdars ms.reviewer: dedaniel, robharad --- @@ -15,7 +16,7 @@ This cmdlet supports retrieving teams with which a specified channel is shared. ## SYNTAX ```PowerShell -Get-SharedWithTeam -HostTeamId -ChannelId [-SharedWithTeamId ] +Get-SharedWithTeam -HostTeamId -ChannelId [-SharedWithTeamId ] [] ``` ## DESCRIPTION @@ -99,5 +100,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-Team](Get-Team.md) -[Get-AssociatedTeam](Get-AssociatedTeam.md) +[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 index 32a78dc594..4a3f016867 100644 --- a/teams/teams-ps/teams/Get-SharedWithTeamUser.md +++ b/teams/teams-ps/teams/Get-SharedWithTeamUser.md @@ -2,9 +2,10 @@ 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: zhongxlmicrosoft -ms.author: zhongxl +author: serdarsoysal +ms.author: serdars ms.reviewer: dedaniel, robharad --- @@ -15,7 +16,7 @@ This cmdlet supports retrieving users of a shared with team. ## SYNTAX ```PowerShell -Get-SharedWithTeamUser -HostTeamId -ChannelId -SharedWithTeamId [-Role ] +Get-SharedWithTeamUser -HostTeamId -ChannelId -SharedWithTeamId [-Role ] [] ``` ## DESCRIPTION @@ -101,7 +102,6 @@ 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). @@ -116,4 +116,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-TeamUser](Get-TeamUser.md) +[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 bc1a2d15a6..b2edb13e51 100644 --- a/teams/teams-ps/teams/Get-Team.md +++ b/teams/teams-ps/teams/Get-Team.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 index 001a2742b0..eae8aeb08e 100644 --- a/teams/teams-ps/teams/Get-TeamAllChannel.md +++ b/teams/teams-ps/teams/Get-TeamAllChannel.md @@ -2,9 +2,10 @@ 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: zhongxlmicrosoft -ms.author: zhongxl +author: serdarsoysal +ms.author: serdars ms.reviewer: dedaniel, robharad --- @@ -15,7 +16,7 @@ This cmdlet supports retrieving all channels of a team, including incoming chann ## SYNTAX ```PowerShell -Get-TeamAllChannel -GroupId [-MembershipType ] +Get-TeamAllChannel -GroupId [-MembershipType ] [] ``` ## DESCRIPTION @@ -83,5 +84,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-TeamChannel](Get-TeamChannel.md) -[Get-TeamIncomingChannel](Get-TeamIncomingChannel.md) +[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 a0f24bd4fd..9eae890d9e 100644 --- a/teams/teams-ps/teams/Get-TeamChannel.md +++ b/teams/teams-ps/teams/Get-TeamChannel.md @@ -2,10 +2,11 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-teamchannel +title: Get-TeamChannel schema: 2.0.0 --- -# Get-TeamChannel +# Get-TeamChannel ## SYNOPSIS This cmdlet supports retrieving channels hosted by a team. diff --git a/teams/teams-ps/teams/Get-TeamChannelUser.md b/teams/teams-ps/teams/Get-TeamChannelUser.md index 474ead8b8d..a245c41c40 100644 --- a/teams/teams-ps/teams/Get-TeamChannelUser.md +++ b/teams/teams-ps/teams/Get-TeamChannelUser.md @@ -2,10 +2,11 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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. diff --git a/teams/teams-ps/teams/Get-TeamIncomingChannel.md b/teams/teams-ps/teams/Get-TeamIncomingChannel.md index 5f852a6b08..b1ad0429ef 100644 --- a/teams/teams-ps/teams/Get-TeamIncomingChannel.md +++ b/teams/teams-ps/teams/Get-TeamIncomingChannel.md @@ -2,9 +2,10 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-teamincomingchannel +title: Get-TeamIncomingChannel schema: 2.0.0 -author: zhongxlmicrosoft -ms.author: zhongxl +author: serdarsoysal +ms.author: serdars ms.reviewer: dedaniel, robharad --- @@ -15,7 +16,7 @@ This cmdlet supports retrieving incoming channels of a team. ## SYNTAX ```PowerShell -Get-TeamIncomingChannel -GroupId +Get-TeamIncomingChannel -GroupId [] ``` ## DESCRIPTION @@ -61,5 +62,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-TeamChannel](Get-TeamChannel.md) -[Get-TeamAllChannel](Get-TeamAllChannel.md) +[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-TeamTargetingHierarchyStatus.md b/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md index 039c1e1e41..2480953c1b 100644 --- a/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md +++ b/teams/teams-ps/teams/Get-TeamTargetingHierarchyStatus.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-teamtargetinghierarchystatus +title: Get-TeamTargetingHierarchyStatus schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -17,7 +18,7 @@ Get the status of a hierarchy upload (see [Set-TeamTargetingHierarchy](https://l ### Get (Default) ``` -Get-TeamTargetingHierarchyStatus [-RequestId ] +Get-TeamTargetingHierarchyStatus [-RequestId ] [-ApiVersion ] [] ``` ## EXAMPLES @@ -80,9 +81,32 @@ 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 diff --git a/teams/teams-ps/teams/Get-TeamUser.md b/teams/teams-ps/teams/Get-TeamUser.md index 1b772e92b3..a7b4fd3d69 100644 --- a/teams/teams-ps/teams/Get-TeamUser.md +++ b/teams/teams-ps/teams/Get-TeamUser.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 a09bd4c2a2..e393faf0f5 100644 --- a/teams/teams-ps/teams/Get-TeamsApp.md +++ b/teams/teams-ps/teams/Get-TeamsApp.md @@ -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 708aadb2e7..39ef59a41c 100644 --- a/teams/teams-ps/teams/Get-TeamsAppInstallation.md +++ b/teams/teams-ps/teams/Get-TeamsAppInstallation.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-teamsappinstallation +title: Get-TeamsAppInstallation schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -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 0014839f78..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://learn.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 3b0ad2ab5f..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://learn.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 3135f4475b..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://learn.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 diff --git a/skype/skype-ps/skype/Grant-CsDialoutPolicy.md b/teams/teams-ps/teams/Grant-CsDialoutPolicy.md similarity index 95% rename from skype/skype-ps/skype/Grant-CsDialoutPolicy.md rename to teams/teams-ps/teams/Grant-CsDialoutPolicy.md index 5ab7b9b445..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://learn.microsoft.com/powershell/module/skype/grant-csdialoutpolicy +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: --- @@ -82,7 +82,7 @@ This parameter sets the tenant global policy instance. This is the policy that a ```yaml Type: SwitchParameter Parameter Sets: GrantToTenant -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -114,7 +114,7 @@ Specifies the Identity of the user account to be to be modified. A user identity ```yaml Type: String Parameter Sets: Identity -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -130,7 +130,7 @@ Returns the results of the command. By default, this cmdlet does not generate an ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -148,7 +148,7 @@ To unassign a per-user policy previously assigned to a user, set the PolicyName ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -223,4 +223,4 @@ The GrantToGroup syntax is supported in Teams PowerShell Module 4.5.1-preview or 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 87ac5d55e0..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://learn.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 diff --git a/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md b/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md index 336a138321..a3f18f52c8 100644 --- a/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md +++ b/teams/teams-ps/teams/Grant-CsGroupPolicyPackageAssignment.md @@ -18,7 +18,7 @@ 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 @@ -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). 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 84% rename from skype/skype-ps/skype/Grant-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md index fe5b3cbfe0..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://learn.microsoft.com/powershell/module/skype/grant-csonlinevoiceroutingpolicy +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 77% rename from skype/skype-ps/skype/Grant-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/teams/Grant-CsOnlineVoicemailPolicy.md index babca8a551..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://learn.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://learn.microsoft.com/powershell/module/skype/get-csonlinevoicemailpolicy?view=skype-ps) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) -[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/skype/set-csonlinevoicemailpolicy?view=skype-ps) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/skype/new-csonlinevoicemailpolicy?view=skype-ps) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://learn.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 66% rename from skype/skype-ps/skype/Grant-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md index 22e9518293..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://learn.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 80% rename from skype/skype-ps/skype/Grant-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md index 13535c2d6e..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://learn.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 @@ -23,14 +24,22 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ### 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 @@ -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 76% rename from skype/skype-ps/skype/Grant-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md index 05fd2d539d..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://learn.microsoft.com/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] @@ -37,8 +45,6 @@ PS C:\> Grant-CsTeamsAudioCOnferencingPolicy -identity "Ken Myer" -PolicyName "E In this example, a user with identity "Ken Myer" is being assigned the "Emea Users" policy. - - ## PARAMETERS ### -Global @@ -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 90% rename from skype/skype-ps/skype/Grant-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md index 6623bcb881..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://learn.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 0c995503f5..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://learn.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 89f70114b8..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://learn.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 1996bfc3bd..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://learn.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 81% rename from skype/skype-ps/skype/Grant-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md index 3ae73db86e..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://learn.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://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.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 547d7057c3..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://learn.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 86% rename from skype/skype-ps/skype/Grant-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md index d6741dbd7c..c86a84aa89 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsEmergencyCallRoutingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsEmergencyCallRoutingPolicy.md @@ -1,203 +1,199 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 -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](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 4bf5ce3196..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://learn.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 89c074a742..58b0be1886 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsEnhancedEncryptionPolicy.md @@ -3,8 +3,8 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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,21 +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) +[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) -[Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) -[Remove-CsTeamsEnhancedEncryptionPolicy](Remove-CsTeamsEnhancedEncryptionPolicy.md) +[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 index 6e3fec7dc5..ad83d722d4 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsEventsPolicy.md @@ -2,6 +2,7 @@ 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 --- @@ -10,7 +11,6 @@ schema: 2.0.0 ## 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) @@ -26,14 +26,14 @@ Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatI ### GrantToGroup ``` -Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] ] +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. +TeamsEventsPolicy is used to configure options for customizing Teams Events experiences. ## EXAMPLES @@ -44,7 +44,6 @@ PS C:\> Grant-CsTeamsEventsPolicy -Identity "user1@contoso.com" -Policy DisableP 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 @@ -52,7 +51,6 @@ 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 @@ -60,7 +58,6 @@ PS C:\> Grant-CsTeamsEventsPolicy -Group "sales@contoso.com" -Rank 10 -Policy Di The command shown in Example 3 assigns the Teams Events policy, DisablePublicWebinars, to the members of the group "sales@contoso.com". - ## PARAMETERS ### -Confirm @@ -119,7 +116,6 @@ 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 @@ -198,7 +194,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 @@ -206,6 +201,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 4470c5a4e0..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://learn.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 d0db771d11..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://learn.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 9811cee898..960fd62910 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMediaLoggingPolicy.md @@ -2,7 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmedialoggingpolicy -applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams title: Grant-CsTeamsMediaLoggingPolicy author: LeoKuhorev ms.author: leokukharau @@ -19,16 +19,21 @@ Assigns Teams Media Logging policy to a user or entire tenant. ## SYNTAX ### Identity (Default) - ``` Grant-CsTeamsMediaLoggingPolicy [[-Identity] ] [-PassThru] [[-PolicyName] ] -[-WhatIf] [-Confirm] [] + [-WhatIf] [-Confirm] [] ``` ### GrantToTenant +``` +Grant-CsTeamsMediaLoggingPolicy [-PassThru] [[-PolicyName] ] + [-Global] [-WhatIf] [-Confirm] [] +``` +### GrantToGroup ``` -Grant-CsTeamsMediaLoggingPolicy [-PassThru] [[-PolicyName] ] [-Global] [-WhatIf] [-Confirm] [] +Grant-CsTeamsMediaLoggingPolicy [-PassThru] [[-PolicyName] ] + -Group [-Rank ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -89,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 @@ -106,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 @@ -127,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,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 @@ -162,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 @@ -179,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 @@ -204,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 f529bd72d2..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://learn.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 eb86cb93f3..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://learn.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 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 d2d15abf80..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://learn.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 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 463d49c712..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://learn.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 6063edf854..43875faa32 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsShiftsPolicy.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 7d7045e1d2..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://learn.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 1b7ac0bc61..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://learn.microsoft.com/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,15 +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) +[Set-CsTeamsVoiceApplicationsPolicy](https://learn.microsoft.com/powershell/module/teams/set-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/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 4b76b7016c..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://learn.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 8cbfbafc14..6d4fc120b3 100644 --- a/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md +++ b/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md @@ -18,7 +18,7 @@ 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 @@ -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 0e95c26575..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://learn.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,25 +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) +[Export-CsAutoAttendantHolidays](https://learn.microsoft.com/powershell/module/teams/export-csautoattendantholidays) -[Get-CsAutoAttendantHolidays](Get-CsAutoAttendantHolidays.md) +[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 80% rename from skype/skype-ps/skype/Import-CsOnlineAudioFile.md rename to teams/teams-ps/teams/Import-CsOnlineAudioFile.md index c5b5e56878..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://learn.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 @@ -32,7 +32,7 @@ $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://learn.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 @@ -40,7 +40,7 @@ $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://learn.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 @@ -48,7 +48,7 @@ $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://learn.microsoft.com/powershell/module/skype/new-csteamscallholdpolicy) 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 @@ -62,7 +62,7 @@ Supported values: - TenantGlobal ```yaml -Type: System.string +Type: String Parameter Sets: (All) Aliases: Applicable: Microsoft Teams @@ -78,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 @@ -94,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 @@ -107,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 @@ -126,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) +[Export-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/export-csonlineaudiofile) -[Get-CsOnlineAudioFile](Get-CsOnlineAudioFile.md) +[Get-CsOnlineAudioFile](https://learn.microsoft.com/powershell/module/teams/get-csonlineaudiofile) -[New-CsOnlineAudioFile](New-CsOnlineAudioFile.md) - -[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 71% rename from skype/skype-ps/skype/New-CsApplicationAccessPolicy.md rename to teams/teams-ps/teams/New-CsApplicationAccessPolicy.md index a5744ac13d..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://learn.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 @@ -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 225b60b69f..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://learn.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 @@ -401,7 +403,7 @@ $defaultVoice = $language.Voices[0].Id 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 70% rename from skype/skype-ps/skype/New-CsAutoAttendantCallFlow.md rename to teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md index 2fc18b19f8..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://learn.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 ] [-ForceListenMenuEnabled ] [] +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,7 +40,7 @@ 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 -ForceListenMenuEnabled $True +$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 with Force listen menu enabled. @@ -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,7 @@ Accept wildcard characters: False Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -119,13 +116,13 @@ Accept wildcard characters: False ### -ForceListenMenuEnabled -If True, 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. +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: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -135,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 9be76d70a3..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://learn.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 ac7885a639..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://learn.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 7663c0804d..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://learn.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 82% rename from skype/skype-ps/skype/New-CsAutoAttendantMenu.md rename to teams/teams-ps/teams/New-CsAutoAttendantMenu.md index d3fba40a9b..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://learn.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 @@ -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,21 +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 e3b2094522..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://learn.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,7 +44,6 @@ $ttsPrompt = New-CsAutoAttendantPrompt -TextToSpeechPrompt "Welcome to Contoso!" This example creates a new prompt that reads the supplied text. - ### -------------------------- Example 2 -------------------------- ```powershell $content = [System.IO.File]::ReadAllBytes('C:\Media\hello.wav') @@ -64,7 +62,6 @@ $dualPrompt = New-CsAutoAttendantPrompt -ActiveType AudioFile -AudioFilePrompt $ 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,20 +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 53033b3c3b..e710dfbc0a 100644 --- a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md @@ -2,10 +2,11 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 [-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 67% rename from skype/skype-ps/skype/New-CsCallingLineIdentity.md rename to teams/teams-ps/teams/New-CsCallingLineIdentity.md index 7c8d04387a..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://learn.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,20 +18,18 @@ 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 @@ -41,21 +39,14 @@ New-CsCallingLineIdentity -Identity Anonymous -Description "anonymous policy" -C This example creates a new Caller ID policy that sets the Caller ID to Anonymous. -### Example 2 +### 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 -``` -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,7 +54,7 @@ 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 5 +### Example 4 ``` New-CsCallingLineIdentity -Identity AllowAnonymousForUsers -EnableUserOverride $true ``` @@ -78,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 @@ -91,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 @@ -107,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 @@ -129,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 @@ -144,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 @@ -164,8 +155,8 @@ EnableUserOverride has precedence over other settings in the policy unless subst ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -181,25 +172,7 @@ This parameter specifies the ObjectId of a resource account/online application i 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 -``` - -### -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 @@ -209,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 @@ -225,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 @@ -241,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 @@ -255,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 index 18fb79a58a..772f8f1d49 100644 --- a/teams/teams-ps/teams/New-CsCloudCallDataConnection.md +++ b/teams/teams-ps/teams/New-CsCloudCallDataConnection.md @@ -1,6 +1,6 @@ --- external help file: MicrosoftTeams-help.xml -Module Name: microsoftteams +Module Name: MicrosoftTeams applicable: Microsoft Teams title: New-CsCloudCallDataConnection online version: https://learn.microsoft.com/powershell/module/teams/new-cscloudcalldataconnection @@ -12,7 +12,6 @@ manager: subadjat --- - # New-CsCloudCallDataConnection ## SYNOPSIS @@ -21,7 +20,7 @@ This cmdlet creates an online call data connection. ## SYNTAX ```powershell -New-CsCloudCallDataConnection +New-CsCloudCallDataConnection [] ``` ## DESCRIPTION @@ -40,7 +39,6 @@ Token Returns a token value, which is needed when configuring your on-premises environment with Set-CsCloudCallDataConnector. - ## PARAMETERS ### CommonParameters @@ -56,9 +54,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -The New-CsCloudCallDataConnection cmdlet is only supported from Teams PowerShell Module versions 4.6.0 or later. +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](/skypeforbusiness/hybrid/configure-call-data-connector) -[Get-CsCloudCallDataConnection](Get-CsCloudCallDataConnection.md) +[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 2d136ca6af..bf6a5dfc6b 100644 --- a/teams/teams-ps/teams/New-CsCustomPolicyPackage.md +++ b/teams/teams-ps/teams/New-CsCustomPolicyPackage.md @@ -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://learn.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://learn.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://learn.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy?view=skype-ps) and [Get-CsTeamsMessagingPolicy](https://learn.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 deafddbaae..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://learn.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,26 +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 ab57bccb31..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://learn.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 b8ad190553..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://learn.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,21 +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 17afd265e5..efbf01984f 100644 --- a/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md @@ -2,10 +2,11 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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: -CallingLineIdentity, TeamsAppSetupPolicy, TeamsAudioConferencingPolicy, TeamsCallingPolicy, TeamsCallParkPolicy, TeamsChannelsPolicy, TeamsComplianceRecordingPolicy, TenantDialPlan, TeamsMeetingBroadcastPolicy, TeamsMeetingPolicy, TeamsMessagingPolicy, TeamsShiftsPolicy, TeamsUpdateManagementPolicy, and TeamsVerticalPackagePolicy. > - 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,22 +115,7 @@ Accept wildcard characters: False ``` ### -PolicyType -The type of the policy to be assigned. -Possible values: -- CallingLineIdentity -- TeamsAppSetupPolicy -- TeamsAudioConferencingPolicy -- TeamsCallingPolicy -- TeamsCallParkPolicy -- TeamsChannelsPolicy -- TeamsComplianceRecordingPolicy -- TenantDialPlan -- TeamsMeetingBroadcastPolicy -- TeamsMeetingPolicy -- TeamsMessagingPolicy -- TeamsShiftsPolicy -- TeamsUpdateManagementPolicy -- TeamsVerticalPackagePolicy +The type of policy to be assigned. ```yaml Type: String @@ -166,7 +159,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -PassThru Returns true when the command succeeds @@ -182,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. @@ -215,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 @@ -226,8 +216,8 @@ For more information, see [About CommonParameters](https://go.microsoft.com/fwli ## RELATED LINKS -[Get-CsUserPolicyAssignment](Get-CsUserPolicyAssignment.md) +[Get-CsUserPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csuserpolicyassignment) -[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/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md b/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md index 35fa6006c9..80fbe8f586 100644 --- a/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md +++ b/teams/teams-ps/teams/New-CsHybridTelephoneNumber.md @@ -3,11 +3,12 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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 9c61c070f1..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://learn.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 fee29f5703..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://learn.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 997d7bad75..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://learn.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,8 +219,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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) -[Remove-CsOnlineApplicationInstanceAssociation](Remove-CsOnlineApplicationInstanceAssociation.md) +[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 ca4dd358d3..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://learn.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 5f22766dce..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://learn.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 2dc11742d7..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://learn.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 94% rename from skype/skype-ps/skype/New-CsOnlinePSTNGateway.md rename to teams/teams-ps/teams/New-CsOnlinePSTNGateway.md index 945d60b372..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://learn.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 @@ -88,7 +88,6 @@ 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 @@ -202,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 @@ -370,7 +368,7 @@ Assigns an ordered list of Teams translation rules, that apply to PSTN number on ```yaml Type: Object Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named Default value: None @@ -440,14 +438,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 @@ -456,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 247ee4ca3f..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://learn.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 2f66ebaf5b..e60b5f483c 100644 --- a/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md +++ b/teams/teams-ps/teams/New-CsOnlineTelephoneNumberOrder.md @@ -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 a91c3a55d5..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://learn.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,18 +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 95% rename from skype/skype-ps/skype/New-CsOnlineVoiceRoute.md rename to teams/teams-ps/teams/New-CsOnlineVoiceRoute.md index d0c29c343c..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://learn.microsoft.com/powershell/module/skype/new-csonlinevoiceroute +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute applicable: Microsoft Teams title: New-CsOnlineVoiceRoute schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -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://learn.microsoft.com/powershell/module/skype/get-csonlinevoiceroute?view=skype-ps) +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) -[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/skype/set-csonlinevoiceroute?view=skype-ps) +[Set-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroute) -[Remove-CsOnlineVoiceRoute](https://learn.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 84% rename from skype/skype-ps/skype/New-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/teams/New-CsOnlineVoiceRoutingPolicy.md index 2b90be1674..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://learn.microsoft.com/powershell/module/skype/new-csonlinevoiceroutingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroutingpolicy applicable: Microsoft Teams title: New-CsOnlineVoiceRoutingPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -16,6 +16,7 @@ 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 [-Identity] [-Description ] [-OnlinePstnUsages ] [-RouteType ] @@ -137,8 +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 @@ -151,10 +151,10 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[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) -[Grant-CsOnlineVoiceRoutingPolicy](grant-csonlinevoiceroutingpolicy.md) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](remove-csonlinevoiceroutingpolicy.md) +[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 80% rename from skype/skype-ps/skype/New-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/teams/New-CsOnlineVoicemailPolicy.md index f374b71298..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://learn.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,19 +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 ] [-PostAmbleAudioFile ] [-PreambleAudioFile ] [-PreamblePostambleMandatory ] -[-PrimarySystemPromptLanguage ] [-SecondarySystemPromptLanguage ] [-ShareData ] [-WhatIf] [-Confirm] [] +[-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 @@ -36,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 @@ -48,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 @@ -57,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 @@ -72,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 @@ -88,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 @@ -104,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 @@ -120,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 @@ -136,8 +136,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 @@ -152,8 +152,8 @@ The audio file to play to the caller after the user's voicemail greeting has pla ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -167,8 +167,8 @@ The audio file to play to the caller before the user's voicemail greeting is pla ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -183,8 +183,8 @@ Is playing the Pre- or Post-amble mandatory before the caller can leave a messag ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -194,13 +194,13 @@ 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 @@ -210,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 @@ -232,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 @@ -248,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 @@ -264,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 @@ -274,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 @@ -283,10 +299,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/skype/get-csonlinevoicemailpolicy?view=skype-ps) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) -[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/skype/set-csonlinevoicemailpolicy?view=skype-ps) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csonlinevoicemailpolicy?view=skype-ps) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://learn.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 2cb34d720e..4230e09bf3 100644 --- a/teams/teams-ps/teams/New-CsTeamTemplate.md +++ b/teams/teams-ps/teams/New-CsTeamTemplate.md @@ -5,7 +5,7 @@ online version: https://learn.microsoft.com/powershell/module/teams/new-csteamte 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,10 +70,10 @@ 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. @@ -83,21 +82,21 @@ 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. @@ -802,7 +804,7 @@ MESSAGINGSETTING \: Governs use of messaging features w ## RELATED LINKS - [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) -- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) -- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) -- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) +- [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 53% rename from skype/skype-ps/skype/New-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/teams/New-CsTeamsAppPermissionPolicy.md index c96f15f247..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://learn.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 89% rename from skype/skype-ps/skype/New-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsAudioConferencingPolicy.md index fe43bcbffb..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://learn.microsoft.com/powershell/module/skype/new-csteamsaudioconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsaudioconferencingpolicy +title: New-CsTeamsAudioConferencingPolicy schema: 2.0.0 --- @@ -155,8 +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) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) -[Grant-CsTeamsAudioConferencingPolicy](Grant-CsTeamsAudioConferencingPolicy.md) +[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 6f831ec581..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://learn.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 090210c2b5..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://learn.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/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md similarity index 50% rename from skype/skype-ps/skype/New-CsTeamsCallingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsCallingPolicy.md index ed8be3523b..638a131b09 100644 --- a/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md @@ -1,469 +1,732 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -Module Name: Skype for Business Online -online version: https://learn.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 -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 -``` - -### -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) +--- +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 69% rename from skype/skype-ps/skype/New-CsTeamsChannelsPolicy.md rename to teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md index e49e4d52d3..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://learn.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 ] - [-EnablePrivateTeamDiscovery ] [-AllowPrivateChannelCreation ] - [-AllowUserToParticipateInExternalSharedChannel ] [-AllowChannelSharingToExternalUser ] [-AllowSharedChannelCreation ] - [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] [] + [-EnablePrivateTeamDiscovery ] [-AllowPrivateChannelCreation ] + [-AllowUserToParticipateInExternalSharedChannel ] [-AllowChannelSharingToExternalUser ] [-AllowSharedChannelCreation ] [-ThreadedChannelCreation ] + [-Identity] [-InMemory] [-Force] [-WhatIf] [-Confirm] [-Description ] [] ``` ## DESCRIPTION @@ -33,7 +29,7 @@ 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. @@ -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://learn.microsoft.com/powershell/module/skype/set-csteamschannelspolicy) +[Set-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamschannelspolicy) -[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csteamschannelspolicy) +[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy) -[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csteamschannelspolicy) +[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy) -[Get-CsTeamsChannelsPolicy](https://learn.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 93% rename from skype/skype-ps/skype/New-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/teams/New-CsTeamsComplianceRecordingApplication.md index b1dd6218ba..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://learn.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://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.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 82% rename from skype/skype-ps/skype/New-CsTeamsComplianceRecordingPairedApplication.md rename to teams/teams-ps/teams/New-CsTeamsComplianceRecordingPairedApplication.md index 913c7a6c37..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://learn.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://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://learn.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 81% rename from skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md index 1a86d3d910..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://learn.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://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.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 265014e532..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://learn.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 69% rename from skype/skype-ps/skype/New-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsEmergencyCallRoutingPolicy.md index 0b485ba4fb..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://learn.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] [] ``` @@ -35,6 +35,14 @@ New-CsTeamsEmergencyCallRoutingPolicy -Identity "Test" -EmergencyNumbers @{add=$ 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,16 +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](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) -[Get-CsTeamsEmergencyCallRoutingPolicy](Get-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 2675ee6411..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://learn.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 9ec02e814b..94d8089d7a 100644 --- a/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsEnhancedEncryptionPolicy.md @@ -3,8 +3,8 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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,20 +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) +[Get-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsenhancedencryptionpolicy) -[Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-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/New-CsTeamsEventsPolicy.md b/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md index ece66637d9..778df29878 100644 --- a/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsEventsPolicy.md @@ -2,7 +2,9 @@ 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 @@ -10,12 +12,13 @@ schema: 2.0.0 ## 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 -``` -New-CsTeamsEventsPolicy [-Identity] [-AllowWebinars ] [-Description ] - [-EventAccessType ] [-WhatIf] [-Confirm] [] +```powershell +New-CsTeamsEventsPolicy [-Identity] [-AllowWebinars ] [-AllowTownhalls ] [-AllowEmailEditing ] [-Description ] +[-TownhallEventAttendeeAccess ] [-RecordingForTownhall ] [-RecordingForWebinar ] +[-TranscriptionForTownhall ] [-TranscriptionForWebinar ] [-AllowEventIntegrations ] [-TownhallChatExperience ] +[-UseMicrosoftECDN ] [-EventAccessType ] [-BroadcastPremiumApps ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -40,12 +43,79 @@ The command shown in Example 2 creates a new per-user Teams Events policy with t ## PARAMETERS ### -AllowWebinars -This setting governs if a user can create webinars using Teams Events. +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 @@ -60,12 +130,12 @@ Accept wildcard characters: False ``` ### -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. +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**: Enables creating events to allow only in-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 @@ -79,8 +149,173 @@ 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 -Prompts you for confirmation before running the cmdlet. +The Confirm switch does not work with this cmdlet. ```yaml Type: SwitchParameter @@ -97,7 +332,6 @@ Accept wildcard characters: False ### -Description Enables administrators to provide explanatory text to accompany a Teams Events policy. - ```yaml Type: String Parameter Sets: (All) @@ -113,7 +347,6 @@ Accept wildcard characters: False ### -Identity Unique identifier assigned to the Teams Events policy. - ```yaml Type: String Parameter Sets: (All) @@ -127,7 +360,7 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. +The WhatIf switch does not work with this cmdlet. The cmdlet is not run. ```yaml @@ -145,7 +378,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 ### None @@ -153,6 +385,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 84% rename from skype/skype-ps/skype/New-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/teams/New-CsTeamsFeedbackPolicy.md index 6eaec2148e..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://learn.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,10 +13,10 @@ 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 @@ -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 34d5623b17..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://learn.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 8a3d2de719..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://learn.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 4b655f02fd..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://learn.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://learn.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://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. +### -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,35 +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. + +Possible values are: -NOTE: You may opt to set Meeting Recordings to never expire by entering the value -1. +- 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 @@ -986,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 @@ -996,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 @@ -1019,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 79% rename from skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md rename to teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md index 3614d6288b..8bd31ac80b 100644 --- a/skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md @@ -1,162 +1,175 @@ ---- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.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 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 -``` - -### CommonParameters -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 86% rename from skype/skype-ps/skype/New-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsNetworkRoamingPolicy.md index 3d79143bbf..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://learn.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 @@ -30,7 +30,7 @@ The TeamsNetworkRoamingPolicy cmdlets enable administrators to provide specific 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 94% rename from skype/skype-ps/skype/New-CsTeamsPinnedApp.md rename to teams/teams-ps/teams/New-CsTeamsPinnedApp.md index 26cb1cd2b4..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 @@ -17,9 +20,6 @@ As an admin, you can use app setup policies to customize Microsoft Teams to high 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) @@ -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 2232e59144..0dcfcf6db0 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md @@ -11,7 +11,6 @@ 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 3b321a5683..9570c08ad4 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md @@ -2,7 +2,7 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: New-CsTeamsShiftsConnectionInstance -author: lespina +author: leonardospina ms.author: lespina manager: valk online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance @@ -18,19 +18,12 @@ This cmdlet creates a Shifts connection instance. ### New (Default) ``` -New-CsTeamsShiftsConnectionInstance -Body [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +New-CsTeamsShiftsConnectionInstance -Body [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### NewExpanded ``` -New-CsTeamsShiftsConnectionInstance -ConnectorId - -ConnectorSpecificSettings -DesignatedActorId - -EnabledConnectorScenario -EnabledWfiScenario -Name -SyncFrequencyInMin - [-ConnectorAdminEmail ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +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 @@ -38,84 +31,57 @@ This cmdlet creates a Shifts connection instance. It allows the admin to set up ## EXAMPLES - -### Example WFM 1 Connection - -```powershell - PS C:\> $result = New-CsTeamsShiftsConnectionInstance -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" -ConnectorAdminEmail "admin@contoso.com", "superadmin@contoso.com" -DesignatedActorId "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8" -EnabledConnectorScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" -EnabledWfiScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" -Name "My Connector Instance" -SyncFrequencyInMin 10 -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" }) - - PS C:\> $result.ToJsonString() -``` -```output -{ - "id": "WCI-45500ca4-b392-4f0c-8703-3618fc6ddc9f", - "tenantId": "113B4CBF-77D6-4456-AC4B-6A17EBD07EF8", - "name": "My Connector Instance", - "connector": { - "id": "6A51B888-FF44-4FEA-82E1-839401E00000", - "name": "WFM 1" - }, - "connectorSpecificSettings": { - "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" - }, - "enabledConnectorScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "workforceIntegrationId": "WFI_8dbddbb0-6cba-4861-a541-192320cc0e88", - "enabledWfiScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "syncFrequencyInMin": 10, - "designatedActorId": "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8", - "etag": "\"0a005fd6-0000-0d00-0000-60a76dbf0000\"", - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ] -} -``` - - -Returns the object of created connector instance. - -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 WFM 2 Connection +### Example 1 ```powershell -PS C:\> $result = New-CsTeamsShiftsConnectionInstance -ConnectorId "95BF2848-2DDA-4425-B0EE-D62AEED00000" -ConnectorAdminEmail "admin@contoso.com", "superadmin@contoso.com" -DesignatedActorId "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8" -EnabledConnectorScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" -EnabledWfiScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" -Name "My Connector Instance" -SyncFrequencyInMin 10 -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" }) - +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-45500ca4-b392-4f0c-8703-3618fc6ddc9f", - "tenantId": "113B4CBF-77D6-4456-AC4B-6A17EBD07EF8", - "name": "My Connector Instance", - "connector": { - "id": "95BF2848-2DDA-4425-B0EE-D62AEED00000", - "name": "WFM 2" - }, - "connectorSpecificSettings": { - apiUrl = "https://contoso.com/api" - ssoUrl = "https://contoso.com/sso" - clientId = "myClientId" - }, - "enabledConnectorScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "workforceIntegrationId": "WFI_8dbddbb0-6cba-4861-a541-192320cc0e88", - "enabledWfiScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "syncFrequencyInMin": 10, - "designatedActorId": "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8", - "etag": "\"0a005fd6-0000-0d00-0000-60a76dbf0000\"" - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ] + "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 an error, we can capture the error response as follows: @@ -129,7 +95,8 @@ In case of an error, we can capture the error response as follows: ## PARAMETERS ### -Body -The request body + +The request body ```yaml Type: IConnectorInstanceRequest @@ -188,14 +155,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorId -The connector id +### -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: NewExpanded Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignatedActorId +Gets or sets the designated actor ID that App acts as for Shifts Graph Api calls. +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: Required: True Position: Named Default value: None @@ -203,14 +183,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -The connector specific settings +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: IConnectorInstanceRequestConnectorSpecificSettings +Type: String Parameter Sets: NewExpanded 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: NewExpanded +Aliases: Required: True Position: Named Default value: None @@ -218,14 +211,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedActorId -Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. +### -SyncScenarioOpenShiftRequest +The sync state for the open shift 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 +``` + +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". +```yaml +Type: String +Parameter Sets: NewExpanded +Aliases: Required: True Position: Named Default value: None @@ -233,14 +239,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledConnectorScenario -The connector enabled scenarios that are synced from WFM system to Shifts in MS Teams. +### -SyncScenarioSwapRequest +The sync state for the swap shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: String[] +Type: String Parameter Sets: NewExpanded 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: NewExpanded +Aliases: Required: True Position: Named Default value: None @@ -248,14 +267,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledWfiScenario -The WFI enabled scenarios that are synced from Shifts in MS Teams to WFM system. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: String[] +Type: String Parameter Sets: NewExpanded 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: NewExpanded +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: NewExpanded +Aliases: Required: True Position: Named Default value: None @@ -264,13 +310,12 @@ Accept wildcard characters: False ``` ### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +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 @@ -279,13 +324,12 @@ Accept wildcard characters: False ``` ### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +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 @@ -300,7 +344,6 @@ The connector instance name. Type: String Parameter Sets: NewExpanded Aliases: - Required: True Position: Named Default value: None @@ -309,12 +352,11 @@ Accept wildcard characters: False ``` ### -Proxy -The URI for the proxy server to use +The URI for the proxy server to use. ```yaml Type: Uri Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -323,13 +365,12 @@ Accept wildcard characters: False ``` ### -ProxyCredential -Credentials for a proxy server to use for the remote call +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 @@ -338,13 +379,12 @@ Accept wildcard characters: False ``` ### -ProxyUseDefaultCredentials -Use the default credentials for the proxy +Use the default credentials for the proxy. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -352,6 +392,20 @@ 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: NewExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SyncFrequencyInMin The sync frequency in minutes. @@ -359,7 +413,6 @@ The sync frequency in minutes. Type: Int32 Parameter Sets: NewExpanded Aliases: - Required: True Position: Named Default value: None @@ -375,7 +428,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi - Required: False Position: Named Default value: None @@ -400,12 +452,12 @@ 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) -[Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.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) -[Get-CsTeamsShiftsConnectionConnector](Get-CsTeamsShiftsConnectionConnector.md) +[Get-CsTeamsShiftsConnectionConnector](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectionconnector) -[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.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 930dce6311..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://learn.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 TimeZone WfmTeamId WfmTeamName ------- -------- -------- --------- ----------- -30b625bd-f0f7-4d5c-8793-9ccef5a6311 America/Los_Angeles 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 1aa457e7f4..57a7c3e428 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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,7 +90,7 @@ 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. @@ -116,7 +101,6 @@ The warning message is shown in the blocking dialog when a user access Teams off '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 524c904cfb..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://learn.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 3750569b94..cf47048628 100644 --- a/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/teams/New-CsTeamsUnassignedNumberTreatment.md @@ -3,11 +3,12 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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,7 +16,6 @@ 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 ### Identity (Default) @@ -62,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 @@ -82,7 +81,6 @@ Accept wildcard characters: False ### -Identity The Id of the treatment. - ```yaml Type: System.String Parameter Sets: (Identity) @@ -95,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 @@ -187,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://learn.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 6505c40529..fd60490292 100644 --- a/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVoiceApplicationsPolicy.md @@ -1,7 +1,8 @@ --- external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/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 --- @@ -10,34 +11,59 @@ ROBOTS: NOINDEX ## 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 ] - [-AllowAutoAttendantBusinessHoursGreetingChange ] [-AllowAutoAttendantHolidayGreetingChange ] - [-AllowAutoAttendantBusinessHoursChange ] [-AllowAutoAttendantTimeZoneChange ] - [-AllowAutoAttendantLanguageChange ] [-AllowAutoAttendantHolidaysChange ] - [-AllowAutoAttendantBusinessHoursRoutingChange ] [-AllowAutoAttendantAfterHoursRoutingChange ] +```powershell +New-CsTeamsVoiceApplicationsPolicy [-Identity] + [-AllowAutoAttendantBusinessHoursGreetingChange ] + [-AllowAutoAttendantAfterHoursGreetingChange ] + [-AllowAutoAttendantHolidayGreetingChange ] + [-AllowAutoAttendantBusinessHoursChange ] + [-AllowAutoAttendantHolidaysChange ] + [-AllowAutoAttendantTimeZoneChange ] + [-AllowAutoAttendantLanguageChange ] + [-AllowAutoAttendantBusinessHoursRoutingChange ] + [-AllowAutoAttendantAfterHoursRoutingChange ] [-AllowAutoAttendantHolidayRoutingChange ] + + [-AllowCallQueueWelcomeGreetingChange ] + [-AllowCallQueueMusicOnHoldChange ] [-AllowCallQueueOverflowSharedVoicemailGreetingChange ] [-AllowCallQueueTimeoutSharedVoicemailGreetingChange ] - [-AllowCallQueueWelcomeGreetingChange ] [-AllowCallQueueMusicOnHoldChange ] - [-AllowCallQueueOptOutChange ] [-AllowCallQueueAgentOptChange ] - [-AllowCallQueueMembershipChange ] [-AllowCallQueueRoutingMethodChange ] + [-AllowCallQueueNoAgentSharedVoicemailGreetingChange ] + [-AllowCallQueueLanguageChange ] + [-AllowCallQueueMembershipChange ] + [-AllowCallQueueConferenceModeChange ] + [-AllowCallQueueRoutingMethodChange ] [-AllowCallQueuePresenceBasedRoutingChange ] + [-AllowCallQueueOptOutChange ] + [-AllowCallQueueOverflowRoutingChange ] + [-AllowCallQueueTimeoutRoutingChange ] + [-AllowCallQueueNoAgentsRoutingChange ] + [-AllowCallQueueAgentOptChange ] + [-CallQueueAgentMonitorMode ] [-CallQueueAgentMonitorNotificationMode ] - [-AllowCallQueueLanguageChange ] [-AllowCallQueueOverflowRoutingChange ] - [-AllowCallQueueTimeoutRoutingChange ] [-AllowCallQueueNoAgentsRoutingChange ] - [-AllowCallQueueConferenceModeChange ] [-WhatIf] [-Confirm] + + [-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 @@ -47,15 +73,15 @@ TeamsVoiceApplicationsPolicy is used for Supervisor Delegated Administration whi New-CsTeamsVoiceApplicationsPolicy -Identity SDA-Allow-CQ-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 @@ -75,9 +101,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantAfterHoursGreetingChange +### -AllowAutoAttendantBusinessHoursGreetingChange -This parameter allows supervisors and users to change auto attendants' after-hours greetings. +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 @@ -91,9 +117,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursGreetingChange +### -AllowAutoAttendantAfterHoursGreetingChange -This parameter allows supervisors and users to change auto attendants' business hours greetings. +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 @@ -109,7 +135,7 @@ 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 @@ -125,7 +151,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantBusinessHoursChange -This parameter allows supervisors and users to change auto attendants' business hours schedule. +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 @@ -139,9 +165,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantTimeZoneChange +### -AllowAutoAttendantHolidaysChange -This parameter allows supervisors and users to change auto attendants' time zone. +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 @@ -155,9 +181,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantLanguageChange +### -AllowAutoAttendantTimeZoneChange -This parameter allows supervisors and users to change auto attendants' language. +_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 @@ -171,9 +199,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidaysChange +### -AllowAutoAttendantLanguageChange + +_This feature is not currently available to authorized users._ -This parameter allows supervisors and users to change auto attendants' holiday schedules. +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 @@ -189,7 +219,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantBusinessHoursRoutingChange -This parameter allows supervisors and users to change auto attendants' business hours call flow. +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 @@ -205,7 +235,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantAfterHoursRoutingChange -This parameter allows supervisors and users to change auto attendants' after-hours call flow. +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 @@ -221,7 +251,7 @@ Accept wildcard characters: False ### -AllowAutoAttendantHolidayRoutingChange -This parameter allows supervisors and users to change auto attendants' holiday call flows. +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 @@ -235,9 +265,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMusicOnHoldChange +### -AllowCallQueueWelcomeGreetingChange -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 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 @@ -251,9 +281,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOptOutChange +### -AllowCallQueueMusicOnHoldChange -This parameter allows supervisors and users to change the call queue opt-out setting that allows agents to opt out of receiving calls. +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 @@ -267,9 +297,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueAgentOptChange +### -AllowCallQueueOverflowSharedVoicemailGreetingChange -This parameter allows supervisors and users to change an agent's opt-in status in the call queue. +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 @@ -283,9 +313,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowSharedVoicemailGreetingChange +### -AllowCallQueueTimeoutSharedVoicemailGreetingChange -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 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 @@ -299,9 +329,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueTimeoutSharedVoicemailGreetingChange +### -AllowCallQueueNoAgentSharedVoicemailGreetingChange -This parameter allows supervisors and users to change call queue timeout shared voicemail information (TTS or AudioFile). +_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 @@ -315,9 +347,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueWelcomeGreetingChange +### -AllowCallQueueLanguageChange + +_This feature is not currently available to authorized users._ -This parameter allows supervisors and users to change the call queue's welcome greeting. +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 @@ -333,7 +367,23 @@ Accept wildcard characters: False ### -AllowCallQueueMembershipChange -This parameter allows supervisors and users to change the call queue's users. +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 @@ -349,7 +399,7 @@ Accept wildcard characters: False ### -AllowCallQueueRoutingMethodChange -This parameter allows supervisors and users to change the call queue's routing method. +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 @@ -365,7 +415,87 @@ Accept wildcard characters: False ### -AllowCallQueuePresenceBasedRoutingChange -This parameter allows supervisors and users to change the call queue's presence-based routing option. +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 @@ -383,23 +513,21 @@ Accept wildcard characters: False PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover -This parameter allows supervisors and users to monitor agents during call sessions and take actions allowed when necessary. - -When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. +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 `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 `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 `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. +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: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -412,13 +540,15 @@ Accept wildcard characters: False PARAMVALUE: Disabled | Agent -This parameter allows supervisors and users to monitor agents. +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: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -427,82 +557,143 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueLanguageChange +### -RealTimeAutoAttendantMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All -This parameter allows supervisors and users to change the call queue's language. +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: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowRoutingChange +### -RealTimeCallQueueMetricsPermission + +PARAMVALUE: Disabled | AuthorizedOnly | All -This parameter allows supervisors and users to change the call queue's overflow handling properties. +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: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueTimeoutRoutingChange +### -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. -This parameter allows supervisors and users to change the call queue's timeout handling properties. +> [!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: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentsRoutingChange +### -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. -This parameter allows supervisors and users to change the call queue's no-agent handling properties. +When set to `All`, users affected by the policy will receive historical metrics for all auto attendants in the organization. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueConferenceModeChange +### -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. -This parameter allows supervisors and users to change the call queue's conference mode. +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: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +applicable: Microsoft Teams Required: False Position: Named -Default value: False +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 ``` @@ -540,6 +731,22 @@ 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). @@ -554,10 +761,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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) -[Set-CsTeamsVoiceApplicationsPolicy](Set-CsTeamsVoiceApplicationsPolicy.md) +[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 53% rename from skype/skype-ps/skype/New-CsTenantDialPlan.md rename to teams/teams-ps/teams/New-CsTenantDialPlan.md index cd5d82a03d..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://learn.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://learn.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,12 +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 55% rename from skype/skype-ps/skype/New-CsTenantNetworkSite.md rename to teams/teams-ps/teams/New-CsTenantNetworkSite.md index d75c7ec94c..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://learn.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://learn.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 @@ -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 20b9163f77..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://learn.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 bece1a85cc..bcb61efbcc 100644 --- a/teams/teams-ps/teams/New-CsUserCallingDelegate.md +++ b/teams/teams-ps/teams/New-CsUserCallingDelegate.md @@ -3,11 +3,12 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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 cee78af82b..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://learn.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 e0318c8307..5ca7ae7b5c 100644 --- a/teams/teams-ps/teams/New-Team.md +++ b/teams/teams-ps/teams/New-Team.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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. +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 @@ -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. @@ -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 05123b978d..579b2c7209 100644 --- a/teams/teams-ps/teams/New-TeamChannel.md +++ b/teams/teams-ps/teams/New-TeamChannel.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/new-teamchannel +title: New-TeamChannel schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -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 f6a96d5312..1ba731d7b5 100644 --- a/teams/teams-ps/teams/New-TeamsApp.md +++ b/teams/teams-ps/teams/New-TeamsApp.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 e508a2e1ca..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://learn.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 136a2714ef..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://learn.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 b1852a8342..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://learn.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 be16a90a29..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://learn.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 b074152ae7..c5fbbf878d 100644 --- a/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md +++ b/teams/teams-ps/teams/Remove-CsCustomPolicyPackage.md @@ -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 ea1f931c07..db975cb1bc 100644 --- a/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/teams/Remove-CsGroupPolicyAssignment.md @@ -2,10 +2,11 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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,8 +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) +[Get-CsGroupPolicyAssignment](https://learn.microsoft.com/powershell/module/teams/get-csgrouppolicyassignment) -[Set-CsGroupPolicyAssignment](Set-CsGroupPolicyAssignment.md) +[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 7630d679ed..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://learn.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 7e8cf23e43..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://learn.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 ec87dc0110..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://learn.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 bde696d956..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://learn.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 37a8140da3..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://learn.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 e44563157e..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://learn.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,18 +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 85% rename from skype/skype-ps/skype/Remove-CsOnlineLisCivicAddress.md rename to teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md index 5a4ec3c947..e78d109481 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineLisCivicAddress.md +++ b/teams/teams-ps/teams/Remove-CsOnlineLisCivicAddress.md @@ -1,19 +1,19 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csonlineliscivicaddress +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). +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. @@ -127,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 85% rename from skype/skype-ps/skype/Remove-CsOnlineLisLocation.md rename to teams/teams-ps/teams/Remove-CsOnlineLisLocation.md index 4666b0280f..4006964361 100644 --- a/skype/skype-ps/skype/Remove-CsOnlineLisLocation.md +++ b/teams/teams-ps/teams/Remove-CsOnlineLisLocation.md @@ -1,19 +1,19 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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). +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. @@ -120,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 94306132ef..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://learn.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 bbbdb60676..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://learn.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 910be59779..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://learn.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 47178ae9bc..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://learn.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 73% rename from skype/skype-ps/skype/Remove-CsOnlinePSTNGateway.md rename to teams/teams-ps/teams/Remove-CsOnlinePSTNGateway.md index 5f7f50d6e2..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://learn.microsoft.com/powershell/module/skype/remove-csonlinepstngateway +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinepstngateway applicable: Microsoft Teams title: Remove-CsOnlinePSTNGateway schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -50,8 +50,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (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 @@ -63,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 8085e09afa..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://learn.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 0ebae55e6a..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://learn.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 86% rename from skype/skype-ps/skype/Remove-CsOnlineVoiceRoute.md rename to teams/teams-ps/teams/Remove-CsOnlineVoiceRoute.md index bbb123592c..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://learn.microsoft.com/powershell/module/skype/remove-csonlinevoiceroute +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroute applicable: Microsoft Teams title: Remove-CsOnlineVoiceRoute schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -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. @@ -96,8 +97,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,8 +108,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Get-CsOnlineVoiceRoute](get-csonlinevoiceroute.md) +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) -[New-CsOnlineVoiceRoute](new-csonlinevoiceroute.md) +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) -[Set-CsOnlineVoiceRoute](set-csonlinevoiceroute.md) +[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 84% rename from skype/skype-ps/skype/Remove-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/teams/Remove-CsOnlineVoiceRoutingPolicy.md index d334692192..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://learn.microsoft.com/powershell/module/skype/remove-csonlinevoiceroutingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoiceroutingpolicy applicable: Microsoft Teams title: Remove-CsOnlineVoiceRoutingPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -99,8 +99,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 @@ -111,10 +110,10 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## 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) -[Grant-CsOnlineVoiceRoutingPolicy](grant-csonlinevoiceroutingpolicy.md) +[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 75% rename from skype/skype-ps/skype/Remove-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/teams/Remove-CsOnlineVoicemailPolicy.md index ce97f18e13..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://learn.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://learn.microsoft.com/powershell/module/skype/get-csonlinevoicemailpolicy?view=skype-ps) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) -[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/skype/set-csonlinevoicemailpolicy?view=skype-ps) +[Set-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/set-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/skype/new-csonlinevoicemailpolicy?view=skype-ps) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://learn.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 0bd1ac900d..2bd32016e0 100644 --- a/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Remove-CsPhoneNumberAssignment.md @@ -3,18 +3,19 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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 ## SYNOPSIS This cmdlet will remove/unassign a phone number from a user or a resource account (online application instance). - + ## SYNTAX ### RemoveSome (Default) @@ -32,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 +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 @@ -53,7 +54,6 @@ Remove-CsPhoneNumberAssignment -Identity user2@contoso.com -RemoveAll ``` This example removes/unassigns the phone number from user2@contoso.com. - ## PARAMETERS ### -Identity @@ -74,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) @@ -131,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 f4569980d6..ee73ec6d3d 100644 --- a/teams/teams-ps/teams/Remove-CsTeamTemplate.md +++ b/teams/teams-ps/teams/Remove-CsTeamTemplate.md @@ -5,7 +5,7 @@ online version: https://learn.microsoft.com/powershell/module/teams/remove-cstea 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,7 +47,7 @@ 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'. 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 72% rename from skype/skype-ps/skype/Remove-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsAppPermissionPolicy.md index 5a8dc2551c..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://learn.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 90% rename from skype/skype-ps/skype/Remove-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsAppSetupPolicy.md index a20ac7b7c8..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://learn.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 @@ -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 84% rename from skype/skype-ps/skype/Remove-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsAudioConferencingPolicy.md index 3ab0a40d12..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://learn.microsoft.com/powershell/module/skype/remove-csteamsaudioconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsaudioconferencingpolicy +title: Remove-CsTeamsAudioConferencingPolicy schema: 2.0.0 --- @@ -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) +[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 f14d86caa2..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://learn.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 eee531cb70..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://learn.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 1657a49828..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://learn.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 a677969ef4..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://learn.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 86% rename from skype/skype-ps/skype/Remove-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingApplication.md index f42378d142..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://learn.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://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.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 83% rename from skype/skype-ps/skype/Remove-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsComplianceRecordingPolicy.md index 06f5fdc029..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://learn.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://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.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 958f79ac8e..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://learn.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 71% rename from skype/skype-ps/skype/Remove-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsEmergencyCallRoutingPolicy.md index 4482903c9a..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://learn.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 @@ -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 5375428c7d..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://learn.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 449a707dcd..2e310c4d61 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsEnhancedEncryptionPolicy.md @@ -3,8 +3,8 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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,21 +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) +[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) -[Set-CsTeamsEnhancedEncryptionPolicy](Set-CsTeamsEnhancedEncryptionPolicy.md) +[Set-CsTeamsEnhancedEncryptionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsenhancedencryptionpolicy) -[Grant-CsTeamsEnhancedEncryptionPolicy](Grant-CsTeamsEnhancedEncryptionPolicy.md) +[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 index 40a6fa0561..adc94c0242 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsEventsPolicy.md @@ -2,6 +2,7 @@ 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 --- @@ -29,7 +30,6 @@ 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 @@ -81,7 +81,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 @@ -89,6 +88,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 f173731810..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://learn.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 fce11a9e83..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://learn.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 +--- +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 e761d7d95a..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://learn.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 1ec9b32545..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://learn.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 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 82% rename from skype/skype-ps/skype/Remove-CsTeamsMessagingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsMessagingPolicy.md index 40df29d893..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://learn.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 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 60dca5650f..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://learn.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 76% rename from skype/skype-ps/skype/Remove-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsNetworkRoamingPolicy.md index c6b10a5a1b..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://learn.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 @@ -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 90% rename from skype/skype-ps/skype/Remove-CsTeamsPinnedApp.md rename to teams/teams-ps/teams/Remove-CsTeamsPinnedApp.md index 254fa1c650..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://learn.microsoft.com/powershell/module/skype/remove-csteamspinnedapp -applicable: Skype for Business Online +applicable: Microsoft Teams title: Remove-CsTeamsPinnedApp schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: williamlooney --- # Remove-CsTeamsPinnedApp @@ -22,7 +22,12 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ## SYNTAX ``` -Remove-CsTeamsPinnedApp [-WhatIf] [-Confirm] [[-Identity] ] [-Tenant ] [-Force] [-AsJob] +Remove-CsTeamsPinnedApp [[-Identity] ] + [-Confirm] + [-Force] + [-Tenant ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -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 d014627a5b..843cf262ce 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnectionInstance.md @@ -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 5431b035ab..f7201e43a2 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsPolicy.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/remove-teamsshiftspolicy +title: Remove-CsTeamsShiftsPolicy schema: 2.0.0 --- @@ -26,8 +27,7 @@ Remove-CsTeamsShiftsPolicy [-Identity] [] PS C:\> Remove-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysShowMessage ``` -In this example, the policy instance to be removed is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage". - +In this example, the policy instance to be removed is called "OffShiftAccess_WarningMessage1_AlwaysShowMessage". ## PARAMETERS @@ -49,7 +49,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 ### Microsoft.Rtc.Management.Xds.XdsIdentity @@ -57,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 f090b3ccee..5c64fec405 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsScheduleRecord.md @@ -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). 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 fb562de4b0..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://learn.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 5a2ebe9ab0..118a64f812 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/teams/Remove-CsTeamsUnassignedNumberTreatment.md @@ -3,11 +3,12 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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 @@ -64,10 +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](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) -[Test-CsTeamsUnassignedNumberTreatment](Test-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 00f8d6f562..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://learn.microsoft.com/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 4b65d2e5bf..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://learn.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,12 +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 c6a10ef466..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://learn.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 dfb3269ba9..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://learn.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 af247f63e0..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://learn.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 e903a4b91d..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://learn.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 ee19854a04..56d6d9bce2 100644 --- a/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md +++ b/teams/teams-ps/teams/Remove-CsUserCallingDelegate.md @@ -3,11 +3,12 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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 cfc202137b..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://learn.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 index 51152814e3..e143bc6c3c 100644 --- a/teams/teams-ps/teams/Remove-SharedWithTeam.md +++ b/teams/teams-ps/teams/Remove-SharedWithTeam.md @@ -2,9 +2,10 @@ 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: zhongxlmicrosoft -ms.author: zhongxl +author: serdarsoysal +ms.author: serdars ms.reviewer: dedaniel, robharad --- @@ -15,7 +16,7 @@ This cmdlet supports unsharing a channel with a team. ## SYNTAX ```PowerShell -Remove-SharedWithTeam -HostTeamId -ChannelId -SharedWithTeamId +Remove-SharedWithTeam -HostTeamId -ChannelId -SharedWithTeamId [] ``` ## DESCRIPTION @@ -90,4 +91,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Remove-Team](Remove-Team.md) +[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 6d6bd3abe9..b379c99308 100644 --- a/teams/teams-ps/teams/Remove-Team.md +++ b/teams/teams-ps/teams/Remove-Team.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 d10d8fa291..9ab0da2703 100644 --- a/teams/teams-ps/teams/Remove-TeamChannel.md +++ b/teams/teams-ps/teams/Remove-TeamChannel.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 fa4a21191f..5593e0c440 100644 --- a/teams/teams-ps/teams/Remove-TeamChannelUser.md +++ b/teams/teams-ps/teams/Remove-TeamChannelUser.md @@ -2,17 +2,20 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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://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). +> [!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 40181407f5..01e2e675e0 100644 --- a/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md +++ b/teams/teams-ps/teams/Remove-TeamTargetingHierarchy.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: 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 diff --git a/teams/teams-ps/teams/Remove-TeamUser.md b/teams/teams-ps/teams/Remove-TeamUser.md index 162ef93f9b..1bc56b8ac7 100644 --- a/teams/teams-ps/teams/Remove-TeamUser.md +++ b/teams/teams-ps/teams/Remove-TeamUser.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 4156d06d7b..a7462e20f9 100644 --- a/teams/teams-ps/teams/Remove-TeamsApp.md +++ b/teams/teams-ps/teams/Remove-TeamsApp.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 486827b9b5..36234579ef 100644 --- a/teams/teams-ps/teams/Remove-TeamsAppInstallation.md +++ b/teams/teams-ps/teams/Remove-TeamsAppInstallation.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/remove-teamsappinstallation +title: Remove-TeamsAppInstallation schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -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 91% rename from skype/skype-ps/skype/Set-CsApplicationMeetingConfiguration.md rename to teams/teams-ps/teams/Set-CsApplicationMeetingConfiguration.md index fdf322d957..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://learn.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 @@ -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 a43b0843de..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://learn.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,30 +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) +[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) -[Get-CsAutoAttendantStatus](Get-CsAutoAttendantStatus.md) +[Get-CsAutoAttendantStatus](https://learn.microsoft.com/powershell/module/teams/get-csautoattendantstatus) -[Remove-CsAutoAttendant](Remove-CsAutoAttendant.md) +[Remove-CsAutoAttendant](https://learn.microsoft.com/powershell/module/teams/remove-csautoattendant) -[Update-CsAutoAttendant](Update-CsAutoAttendant.md) +[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 69% rename from skype/skype-ps/skype/Set-CsCallingLineIdentity.md rename to teams/teams-ps/teams/Set-CsCallingLineIdentity.md index b33b5fe50a..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://learn.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,23 +40,15 @@ 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" -``` - -This example modifies the UKOrgAA Caller ID policy to sets the Caller ID to a specified service number. - -### Example 3 -``` PS C:\> Set-CsCallingLineIdentity -Identity Anonymous -Description "anonymous policy" -CallingIDSubstitute Anonymous -EnableUserOverride $false -BlockIncomingPstnCallerID $true ``` -This example modifies the new Anonymous Caller ID policy that blocks the incoming Caller ID. +This example modifies the new Anonymous Caller ID policy to block the incoming Caller ID. -### Example 4 +### Example 3 ``` $ObjId = (Get-CsOnlineApplicationInstance -Identity dkcq@contoso.com).ObjectId Set-CsCallingLineIdentity -Identity DKCQ -CallingIDSubstitute Resource -ResourceAccount $ObjId -CompanyName "Contoso" @@ -66,7 +56,7 @@ Set-CsCallingLineIdentity -Identity DKCQ -CallingIDSubstitute Resource -Resource 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 5 +### Example 4 ``` Set-CsCallingLineIdentity -Identity AllowAnonymousForUsers -EnableUserOverride $true ``` @@ -76,17 +66,15 @@ This example modifies the Caller ID policy and allows Teams users to make anonym ## 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 @@ -97,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 @@ -119,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 @@ -134,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 @@ -154,8 +142,8 @@ EnableUserOverride has precedence over other settings in the policy unless subst ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -170,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 @@ -187,26 +175,7 @@ This parameter specifies the ObjectId of a resource account/online application i 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 @@ -223,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 @@ -239,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 @@ -249,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 @@ -258,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 af846a6be2..c74a4f85ba 100644 --- a/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/teams/Set-CsGroupPolicyAssignment.md @@ -2,10 +2,11 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 800a34155e..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://learn.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 df9a3e8103..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://learn.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 ab2c693dce..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://learn.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 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 6d9e6b0f3f..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://learn.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,18 +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 73% rename from skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md rename to teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md index 19d979c5b5..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://learn.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://learn.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,7 +59,6 @@ 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 @@ -62,7 +68,7 @@ For example "9884626f-dcfb-49f4-8025-912f5bc68fdc". You can either specify Bridg ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Applicable: Skype for Business Online Required: False @@ -79,7 +85,7 @@ 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 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 f9fe6a0cf8..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://learn.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://learn.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 98515cf05c..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://learn.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 b7f5b6baa6..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://learn.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 427d0c8e8c..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://learn.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 1812dbcff3..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://learn.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 b0f6a74cd0..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://learn.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 4d91a812ed..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://learn.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 94% rename from skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md rename to teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md index 595679ab58..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://learn.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: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -158,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 @@ -411,8 +410,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 @@ -424,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 91% rename from skype/skype-ps/skype/Set-CsOnlinePstnUsage.md rename to teams/teams-ps/teams/Set-CsOnlinePstnUsage.md index 07fb1ba906..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://learn.microsoft.com/powershell/module/skype/set-csonlinepstnusage +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinepstnusage applicable: Microsoft Teams title: Set-CsOnlinePstnUsage schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -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 @@ -135,4 +134,4 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Get-CsOnlinePstnUsage](get-csonlinepstnusage.md) +[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 258e6f3d2a..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://learn.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 70% rename from skype/skype-ps/skype/Set-CsOnlineVoiceApplicationInstance.md rename to teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md index 75b14c1ed4..f62687992e 100644 --- a/skype/skype-ps/skype/Set-CsOnlineVoiceApplicationInstance.md +++ b/teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md @@ -1,165 +1,175 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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 has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) and -[Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. - -## 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://learn.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 93% rename from skype/skype-ps/skype/Set-CsOnlineVoiceRoute.md rename to teams/teams-ps/teams/Set-CsOnlineVoiceRoute.md index e3db36eda7..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://learn.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 @@ -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](get-csonlinevoiceroute.md) +[Get-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoiceroute) -[New-CsOnlineVoiceRoute](new-csonlinevoiceroute.md) +[New-CsOnlineVoiceRoute](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoiceroute) -[Remove-CsOnlineVoiceRoute](remove-csonlinevoiceroute.md) +[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 87% rename from skype/skype-ps/skype/Set-CsOnlineVoiceRoutingPolicy.md rename to teams/teams-ps/teams/Set-CsOnlineVoiceRoutingPolicy.md index a2db16a2c6..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://learn.microsoft.com/powershell/module/skype/set-csonlinevoiceroutingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlinevoiceroutingpolicy applicable: Microsoft Teams title: Set-CsOnlineVoiceRoutingPolicy schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -154,8 +154,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,10 +165,10 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## 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) -[Grant-CsOnlineVoiceRoutingPolicy](grant-csonlinevoiceroutingpolicy.md) +[Grant-CsOnlineVoiceRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csonlinevoiceroutingpolicy) -[Remove-CsOnlineVoiceRoutingPolicy](remove-csonlinevoiceroutingpolicy.md) +[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 82% rename from skype/skype-ps/skype/Set-CsOnlineVoiceUser.md rename to teams/teams-ps/teams/Set-CsOnlineVoiceUser.md index 3354cfaa53..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://learn.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: --- @@ -16,8 +16,8 @@ ms.reviewer: Use the `Set-CsOnlineVoiceUser` cmdlet to set the PSTN specific parameters (like telephone numbers and emergency response locations.) **Note**: This cmdlet has been deprecated. Use the new -[Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) and -[Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. +[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 @@ -61,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 @@ -78,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 @@ -94,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 @@ -111,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 @@ -130,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 @@ -148,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 @@ -164,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 @@ -181,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 @@ -191,18 +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 79% rename from skype/skype-ps/skype/Set-CsOnlineVoicemailPolicy.md rename to teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md index 01953ffdd6..e5f0a4f436 100644 --- a/skype/skype-ps/skype/Set-CsOnlineVoicemailPolicy.md +++ b/teams/teams-ps/teams/Set-CsOnlineVoicemailPolicy.md @@ -1,25 +1,25 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.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] [] @@ -28,7 +28,7 @@ Set-CsOnlineVoicemailPolicy [[-Identity] ] [-EnableEditingCallAnswerRule ## 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 @@ -36,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 @@ -55,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 @@ -64,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 @@ -80,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 @@ -96,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 @@ -112,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 @@ -128,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 @@ -144,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 @@ -160,8 +159,8 @@ The audio file to play to the caller after the user's voicemail greeting has pla ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -174,8 +173,8 @@ The audio file to play to the caller before the user's voicemail greeting is pla ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named Default value: None @@ -189,8 +188,8 @@ Is playing the Pre- or Post-amble mandatory before the caller can leave a messag ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named Default value: False @@ -199,13 +198,13 @@ 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 @@ -215,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 @@ -237,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 @@ -253,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 @@ -269,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 @@ -279,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 @@ -288,10 +302,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/skype/get-csonlinevoicemailpolicy?view=skype-ps) +[Get-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/get-csonlinevoicemailpolicy) -[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/skype/new-csonlinevoicemailpolicy?view=skype-ps) +[New-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/new-csonlinevoicemailpolicy) -[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csonlinevoicemailpolicy?view=skype-ps) +[Remove-CsOnlineVoicemailPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csonlinevoicemailpolicy) -[Grant-CsOnlineVoicemailPolicy](https://learn.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 17d37a0ea2..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://learn.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 6c386490ff..4ef22599c9 100644 --- a/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md +++ b/teams/teams-ps/teams/Set-CsPhoneNumberAssignment.md @@ -3,11 +3,12 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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 @@ -17,9 +18,20 @@ This cmdlet will assign a phone number to a user or a resource account (online a ## SYNTAX -### Assignment (Default) +### LocationUpdate (Default) +```powershell +Set-CsPhoneNumberAssignment -PhoneNumber -LocationId [] +``` + +### NetworkSiteUpdate ```powershell -Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType [-LocationId ] [] +Set-CsPhoneNumberAssignment -PhoneNumber -NetworkSiteId [] +``` + +### Assignment +```powershell +Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType + [-LocationId ] [-NetworkSiteId ] [-AssignmentCategory ] [] ``` ### Attribute @@ -27,20 +39,22 @@ Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumbe Set-CsPhoneNumberAssignment -Identity -EnterpriseVoiceEnabled [] ``` -## 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. +### ReverseNumberLookup +```powershell +Set-CsPhoneNumberAssignment -PhoneNumber -ReverseNumberLookup [] +``` -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. +### Notify +```powershell +Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType -Notify [] +``` -**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 occurred. +## 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. -**Note**: Macau region is currently not supported for phone number assignment or Enterprise Voice. +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 @@ -77,18 +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 -Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=100" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occured } +Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=1234" -PhoneNumberType DirectRouting -ErrorAction Stop } Catch { Write-Host An error occurred } ``` 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. @@ -97,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 @@ -122,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 @@ -139,19 +243,18 @@ 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 @@ -165,6 +268,35 @@ 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 @@ -183,7 +315,7 @@ 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. @@ -192,8 +324,7 @@ If a user or resource account has a phone number set in Active Directory on-prem 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 a94503e433..d5d3e1c8a6 100644 --- a/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsAcsFederationConfiguration.md @@ -12,28 +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 ] - [-AllowedAcsResources ] - [-WhatIf] - [-Confirm] - [] + [-Identity ] + [-EnableAcsUsers ] + [-AllowedAcsResources ] + [-WhatIf] + [-Confirm] + [] ``` ## DESCRIPTION -Federation between Teams and Azure Communication Services (ACS) allows external users from ACS 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. 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 @@ -58,8 +57,6 @@ Set-CsTeamsAcsFederationConfiguration -EnableAcsUsers $True -AllowedAcsResources 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 @@ -82,6 +79,22 @@ 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: (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). @@ -93,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 90% rename from skype/skype-ps/skype/Set-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsAudioConferencingPolicy.md index 33f4ba37fe..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://learn.microsoft.com/powershell/module/skype/set-csteamsaudioconferencingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy +title: Set-CsTeamsAudioConferencingPolicy schema: 2.0.0 --- @@ -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) +[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 60f3d11e42..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://learn.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 c5124e2a7d..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://learn.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 74% rename from skype/skype-ps/skype/Set-CsTeamsChannelsPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md index d94ce81069..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://learn.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 ] - [-EnablePrivateTeamDiscovery ] [-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,7 +43,7 @@ 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. @@ -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://learn.microsoft.com/powershell/module/skype/new-csteamschannelspolicy) +[New-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamschannelspolicy) -[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csteamschannelspolicy) +[Remove-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamschannelspolicy) -[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csteamschannelspolicy) +[Grant-CsTeamsChannelsPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamschannelspolicy) -[Get-CsTeamsChannelsPolicy](https://learn.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 93% rename from skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md rename to teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md index 0848d5d414..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://learn.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 @@ -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 93% rename from skype/skype-ps/skype/Set-CsTeamsComplianceRecordingApplication.md rename to teams/teams-ps/teams/Set-CsTeamsComplianceRecordingApplication.md index 09a382c71d..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://learn.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://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Set-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.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 88% rename from skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md index b95c53b91a..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://learn.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://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingpolicy?view=skype-ps) - -[New-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingpolicy?view=skype-ps) - -[Grant-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/grant-csteamscompliancerecordingpolicy?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingPolicy](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingpolicy?view=skype-ps) - -[Get-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/get-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/new-csteamscompliancerecordingapplication?view=skype-ps) - -[Set-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/set-csteamscompliancerecordingapplication?view=skype-ps) - -[Remove-CsTeamsComplianceRecordingApplication](https://learn.microsoft.com/powershell/module/skype/remove-csteamscompliancerecordingapplication?view=skype-ps) - -[New-CsTeamsComplianceRecordingPairedApplication](https://learn.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 ab02aad8eb..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://learn.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 a295cf3a10..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://learn.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 index 3cd5f44989..2574fce8c8 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsEducationConfiguration.md @@ -2,8 +2,8 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams title: Set-CsTeamsEducationConfiguration -author: prrathna -ms.author: prrathna +author: SaritaBehera +ms.author: saritabehera online version: https://learn.microsoft.com/powershell/module/teams/set-csteamseducationconfiguration schema: 2.0.0 --- @@ -18,17 +18,18 @@ This cmdlet is used to manage the organization-wide education configuration for ```powershell Set-CsTeamsEducationConfiguration - [-ParentGuardianPreferredContactMethod ] - [-WhatIf] - [-Confirm] - [] + [-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 or a Global Administrator for your organization to run the cmdlet. +You must be a Teams Service Administrator for your organization to run the cmdlet. ## EXAMPLES @@ -46,6 +47,20 @@ In this example, SMS is set as the preferred contact method used for parent comm 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 @@ -59,6 +74,17 @@ 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). @@ -70,4 +96,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsEducationConfiguration](Get-CsTeamsEducationConfiguration.md) +[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 78% rename from skype/skype-ps/skype/Set-CsTeamsEmergencyCallRoutingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsEmergencyCallRoutingPolicy.md index 1b2e5ca47d..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://learn.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 --- @@ -84,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 @@ -144,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 @@ -154,12 +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](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) -[Get-CsTeamsEmergencyCallRoutingPolicy](Get-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 32310bf61a..33b326f662 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsEnhancedEncryptionPolicy.md @@ -3,8 +3,8 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 index 8578b50502..bf14cb6cb1 100644 --- a/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsEventsPolicy.md @@ -2,7 +2,9 @@ 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 @@ -13,8 +15,13 @@ This cmdlet allows you to configure options for customizing Teams events experie ## SYNTAX ``` -Set-CsTeamsEventsPolicy [-AllowWebinars ] [-Description ] [-EventAccessType ] - [[-Identity] ] [-WhatIf] [-Confirm] [] +Set-CsTeamsEventsPolicy [-AllowWebinars ] [-EventAccessType ] [-AllowTownhalls ] + [-TownhallEventAttendeeAccess ] [-AllowEmailEditing ] [-AllowedQuestionTypesInRegistrationForm ] + [-AllowEventIntegrations ] [-AllowedWebinarTypesForRecordingPublish ] + [-AllowedTownhallTypesForRecordingPublish ] [-TownhallChatExperience ] [-Description ] + [-RecordingForTownhall ] [-RecordingForWebinar ] + [-TranscriptionForTownhall ] [-TranscriptionForWebinar ] + [-UseMicrosoftECDN ] [-BroadcastPremiumApps ] ``` ## DESCRIPTION @@ -24,7 +31,7 @@ User-level policy for tenant admin to configure options for customizing Teams ev ### Example 1 ```powershell -PS C:\> Set-CsTeamsEventsPolicy -Identity Global -AllowWebinars Disabled +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. @@ -37,6 +44,104 @@ 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 @@ -51,7 +156,7 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. +The Confirm switch does not work with this cmdlet. ```yaml Type: SwitchParameter @@ -68,7 +173,6 @@ Accept wildcard characters: False ### -Description Enables administrators to provide explanatory text to accompany a Teams Events policy. - ```yaml Type: String Parameter Sets: (All) @@ -82,12 +186,15 @@ Accept wildcard characters: False ``` ### -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. + +> [!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) @@ -103,7 +210,6 @@ Accept wildcard characters: False ### -Identity Unique identifier assigned to the Teams Events policy. - ```yaml Type: String Parameter Sets: (All) @@ -116,8 +222,207 @@ 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 -Shows what would happen if the cmdlet runs. +The WhatIf switch does not work with this cmdlet. The cmdlet is not run. ```yaml @@ -135,7 +440,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 ### None @@ -143,6 +447,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 5835954eb6..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://learn.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 c769e3ed56..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://learn.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 bfc4f46c4c..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://learn.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 f9d329718c..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://learn.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 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 9c985ab2c7..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://learn.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 a3ff7310e1..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://learn.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 e646698a6f..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://learn.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 bb9ebb349d..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://learn.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/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md similarity index 50% rename from skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md index 0ad11c48c1..5adc506782 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-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/set-csteamsmeetingpolicy +Module Name: MicrosoftTeams +applicable: Microsoft Teams title: Set-CsTeamsMeetingPolicy schema: 2.0.0 manager: bulenteg author: tomkau ms.author: tomkau -ms.reviewer: +ms.reviewer: alejandramu +ms.date: 2/26/2025 --- # Set-CsTeamsMeetingPolicy @@ -20,26 +22,112 @@ The `CsTeamsMeetingPolicy` cmdlets enable administrators to control the type of ### Identity (Default) ```powershell -Set-CsTeamsMeetingPolicy [-Tenant ] [-Description ] - [-AllowChannelMeetingScheduling ] [-AllowCartCaptionsScheduling ] [-LiveInterpretationEnabledType ] [-AllowMeetNow ] [-AllowPrivateMeetNow ] - [-MeetingChatEnabledType ] [-LiveCaptionsEnabledType ] [-AllowIPVideo ] [-IPAudioMode ] [-IPVideoMode ] +Set-CsTeamsMeetingPolicy [[-Identity] ] + [-AIInterpreter ] + [-AllowAnnotations ] [-AllowAnonymousUsersToDialOut ] - [-AllowAnonymousUsersToJoinMeeting ] [-AllowAnonymousUsersToStartMeeting ] + [-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 ] - [-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] [] + [-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 @@ -58,7 +146,6 @@ 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 @@ -76,66 +163,52 @@ Set-CsTeamsMeetingPolicy -Identity NonEVNetworkRoamingPolicy -AllowNetworkConfig ``` 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. +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. +### -Identity +Specify the name of the policy being created. ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: True +Position: 1 +Default value: None 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: +### -AIInterpreter +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Enables the user to use the AI Interpreter related features -### -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). 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. +Possible values: -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. +- Disabled +- Enabled ```yaml -Type: List +Type: String Parameter Sets: (All) Aliases: +Applicable: Microsoft Teams Required: False Position: Named -Default value: Empty List +Default value: Enabled 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. +### -AllowAnnotations -> [!NOTE] -> This only restricts from scheduling and not from joining a meeting scheduled by another user. +This setting will allow admins to choose which users will be able to use the Annotation feature. ```yaml Type: Boolean @@ -149,8 +222,9 @@ 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. +### -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 @@ -164,8 +238,11 @@ 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. +### -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 @@ -174,13 +251,13 @@ Aliases: Required: False Position: Named -Default value: False +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. +### -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 @@ -193,9 +270,9 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowAvatarsInGallery -### -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. +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 @@ -209,26 +286,17 @@ 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: +### -AllowCarbonSummary -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +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. -### -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. +> [!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: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -240,10 +308,11 @@ 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. +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. +- **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 @@ -258,27 +327,26 @@ 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. +### -AllowBreakoutRooms +Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: DisabledUserOverride +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. -### -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. +> [!NOTE] +> This only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml Type: Boolean @@ -292,8 +360,8 @@ 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. +### -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 @@ -307,11 +375,12 @@ 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. +### -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: @@ -322,11 +391,17 @@ 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. +### -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: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -337,11 +412,9 @@ 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. +### -AllowExternalNonTrustedMeetingChat -> [!NOTE] -> This only restricts from scheduling and not from joining a meeting scheduled by another user. +This field controls whether a user is allowed to chat in external meetings with users from non trusted organizations. ```yaml Type: Boolean @@ -355,8 +428,8 @@ 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. +### -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 @@ -370,8 +443,9 @@ 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. +### -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 @@ -385,8 +459,8 @@ 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. +### -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 @@ -395,26 +469,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). +### -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: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -425,13 +489,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowLocalRecording +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -440,12 +504,13 @@ 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. +### -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: @@ -456,41 +521,46 @@ 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. +### -AllowMeetingReactions +Set to false to disable Meeting Reactions. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy being created. +### -AllowMeetingRegistration +Controls if a user can create a webinar meeting. The default value is True. + +Possible values: + +- True +- False ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: Required: False -Position: 1 -Default value: None +Position: Named +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaBitRateKb -Determines the media bit rate for audio/video/app sharing transmissions in meetings. +### -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: UInt32 +Type: Boolean Parameter Sets: (All) Aliases: @@ -501,52 +571,57 @@ 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. +### -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: String +Type: Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named -Default value: None +Default value: False 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" +### -AllowNDIStreaming +This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network. -You can return your tenant ID by running this command: +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: -Get-CsTenant | Select-Object DisplayName, TenantID +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -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. +### -AllowOrganizersToOverrideLobbySettings +This parameter has been deprecated and currently has no effect. ```yaml -Type: Guid +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +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. +### -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: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -555,8 +630,8 @@ 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. +### -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 @@ -570,11 +645,11 @@ 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. +### -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: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -600,12 +675,11 @@ 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. +### -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 parameter is temporarily disabled. +> This only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml Type: Boolean @@ -619,40 +693,679 @@ 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. +### -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: TeamsAndSfb +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. +### -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: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -LiveCaptionsEnabledType +### -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 @@ -662,21 +1375,139 @@ Aliases: Required: False Position: Named -Default value: DisabledUserOverride +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 ``` -### -VideoFiltersMode -Determines the background effects that a user can configure in the Teams client. Possible values are: +### -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. -- 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. +> [!NOTE] +> You may opt to set Meeting Recordings to never expire by entering the value -1. ```yaml -Type: String +Type: Int32 Parameter Sets: (All) Aliases: @@ -686,19 +1517,24 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -NoiseSuppressionForDialInParticipants -### -AllowEngagementReport -Determines whether meeting organizers are allowed to download the attendee engagement report. Possible values are: +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. -- Enabled: allow the meeting organizer to download the report. -- Disabled: disable attendee report generation and prohibit meeting organizer from downloading it. +Control Noises Supression Feature for PST legs joining a meeting. -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. +Possible Values: + +- MicrosoftDefault +- Enabled +- Disabled ```yaml Type: String Parameter Sets: (All) Aliases: +Applicable: Microsoft Teams Required: False Position: Named @@ -707,11 +1543,16 @@ 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. +### -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: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -722,14 +1563,8 @@ 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. +### -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 @@ -738,60 +1573,81 @@ Aliases: Required: False Position: Named -Default value: None +Default value: TeamsAndSfb 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. +### -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: Enum +Type: String +Parameter Sets: (All) +Aliases: + +Required: False Position: Named -Default value: AllFilters +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. +### -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: 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 ``` -### -AllowOrganizersToOverrideLobbySettings -This parameter has been deprecated and currently has no effect. +### -RoomAttributeUserOverride +Possible values: + +- Off +- Distinguish +- Attribute ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserToJoinExternalMeeting -Currently, this parameter has no effect. +### -RoomPeopleNameUserOverride -Possible values are: -- Enabled -- FederatedOnly -- Disabled +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 @@ -800,15 +1656,13 @@ Aliases: Required: False Position: Named -Default value: Disabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnrollUserOverride -Possible values are: -- Disabled -- Enabled +### -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 @@ -817,20 +1671,35 @@ Aliases: Required: False Position: Named -Default value: Disabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StreamingAttendeeMode +### -SmsNotifications +Participants can sign up for text message meeting reminders. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: -Controls if Teams uses overflow capability once a meeting reaches its capacity (1,000 users with full functionality). +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -Possible values are: -- Disabled -- Enabled +### -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. -Set this to Enabled to allow up to 20,000 extra view-only attendees to join. +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 @@ -839,30 +1708,39 @@ 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. +### -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: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` ### -TeamsCameraFarEndPTZMode -Possible values are: +Possible values are: + - Disabled -- AutoAcceptInTenant +- AutoAcceptInTenant - AutoAcceptAll ```yaml @@ -877,45 +1755,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMeetingReactions -Set to false to disable Meeting Reactions. +### -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: Boolean +Type: Guid Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMeetingRegistration -Controls if a user can create a webinar meeting. The default value is True. +### -UsersCanAdmitFromLobby -Possible values: -- True -- False +This policy controls who can admit from the lobby. ```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 ``` -### -AllowScreenContentDigitization -This parameter is reserved for internal Microsoft use. +### -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: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -926,14 +1814,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTrackingInReport -This parameter is reserved for internal Microsoft use. +### -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: Boolean +Type: String Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -941,30 +1832,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RoomAttributeUserOverride -Possible values: +### -VoiceSimulationInInterpreter -- Off -- Distinguish -- Attribute +> [!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: None +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` -### -SpeakerAttributionMode -Possible values: +### -WatermarkForAnonymousUsers -- EnabledUserOverride -- Disabled +Determines the meeting experience and watermark content of an anonymous user. ```yaml Type: String @@ -978,13 +1873,25 @@ 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'. +### -WatermarkForCameraVideoOpacity -Possible values: +Allows the transparency of watermark to be customizable. -- Everyone -- EveryoneInCompany +```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 @@ -993,18 +1900,17 @@ Aliases: Required: False Position: Named -Default value: Everyone +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. +### -WatermarkForScreenSharingOpacity -NOTE: You may opt to set Meeting Recordings to never expire by entering the value -1. +Allows the transparency of watermark to be customizable. ```yaml -Type: Int32 +Type: Int64 Parameter Sets: (All) Aliases: @@ -1015,18 +1921,14 @@ 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). +### -WatermarkForScreenSharingPattern -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. +Allows the pattern design of watermark to be customizable. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1035,13 +1937,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelRecordingDownload -Controls how channel meeting recordings are saved, permissioned, and who can download them. - -Possible values: +### -AllowedUsersForMeetingDetails +Controls which users should have ability to see the meeting info details on join screen. 'None' option should disable the feature completely. -- 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. +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 @@ -1050,31 +1951,57 @@ Aliases: Required: False Position: Named -Default value: Allow +Default value: UsersAllowedToByPassTheLobby 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. +### -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: Boolean +Type: String Parameter Sets: (All) Aliases: +Applicable: Microsoft Teams + Required: False Position: Named -Default value: False +Default value: Enabled 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). +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. -Possible values are: -- Disabled -- Enabled +```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 @@ -1083,16 +2010,18 @@ Aliases: Required: False Position: Named -Default value: None +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 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/skype/skype-ps/skype/Set-CsTeamsMessagingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md similarity index 51% rename from skype/skype-ps/skype/Set-CsTeamsMessagingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md index 02bcc06d16..d7182ff633 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md @@ -1,13 +1,9 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-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/set-csteamsmessagingpolicy +applicable: Microsoft Teams title: Set-CsTeamsMessagingPolicy schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: --- # Set-CsTeamsMessagingPolicy @@ -19,29 +15,99 @@ The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is ### Identity (Default) ``` -Set-CsTeamsMessagingPolicy [-Tenant ] [-Description ] [-AllowUrlPreviews ] - [-AllowOwnerDeleteMessage ] [-AllowUserEditMessage ] [-AllowUserDeleteMessage ] - [-AllowUserChat ] [-AllowUserDeleteChat ] [-AllowGiphy ] [-GiphyRatingType ] [-AllowMemes ] - [-AllowStickers ] [-AllowUserTranslation ] [-AllowImmersiveReader ] - [-AllowRemoveUser ] [-AllowPriorityMessages ] [-AllowSmartReply ] [-Allow [-ReadReceiptsEnabledType ] - [-AudioMessageEnabledType ] [-ChannelsInChatListEnabledType ] - [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] [-ChatPermissionRole ] [-AllowSmartCompose] ] +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 [-Tenant ] [-Description ] [-AllowUrlPreviews ] - [-AllowOwnerDeleteMessage ] [-AllowUserEditMessage ] [-AllowUserDeleteMessage ] - [-AllowUserChat ] [-AllowUserDeleteChat ] [-AllowGiphy ] [-GiphyRatingType ] [-AllowMemes ] - [-AllowStickers ] [-AllowUserTranslation ] [-AllowImmersiveReader ] - [-AllowRemoveUser ] [-AllowPriorityMessages ] [-AllowSmartReply ] [-ReadReceiptsEnabledType ] - [-AudioMessageEnabledType ] [-ChannelsInChatListEnabledType ] [-AllowSmartCompose] ] - [-Instance ] [-Force] [-WhatIf] [-Confirm] [] +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. - +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 @@ -63,12 +129,171 @@ PS C:\> Get-CsTeamsMessagingPolicy -Identity StudentMessagingPolicy | Set-CsTeam 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. + +**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 @@ -127,8 +352,9 @@ 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. +### -AllowPasteInternetImage +Determines if a user is allowed to paste internet-based images in compose. +Possible values: True, False ```yaml Type: Boolean @@ -142,8 +368,8 @@ 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. +### -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 @@ -172,6 +398,52 @@ 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. @@ -187,6 +459,23 @@ 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. @@ -263,9 +552,9 @@ 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. +### -AllowVideoMessages +This setting determines if users can create and send video messages. +Possible values: True, False ```yaml Type: Boolean @@ -311,6 +600,17 @@ 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. @@ -326,11 +626,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Provide a description of your policy to identify purpose of creating it. +### -CreateCustomEmojis +This setting enables the creation of custom emojis and reactions within an organization for the specified policy users. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -341,11 +641,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. +### -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: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -356,8 +656,8 @@ 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. +### -Description +Provide a description of your policy to identify purpose of creating it. ```yaml Type: String @@ -371,28 +671,58 @@ 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. +### -DesignerForBackgroundsAndImages +This setting determines whether a user is allowed to create custom AI-powered backgrounds and images with MS Designer. -If you do not specify an Identity the Set-CsTeamsMessagingPolicy cmdlet will automatically modify the global policy. +Possible values are: Enabled, Disabled. ```yaml -Type: Object +Type: DesignerForBackgroundsAndImagesTypeEnum Parameter Sets: (All) Aliases: Required: False -Position: 1 +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 ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -GiphyRatingType +Determines the Giphy content restrictions applicable to a user. Set this to STRICT, MODERATE or NORESTRICTION. ```yaml -Type: XdsIdentity +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: @@ -421,11 +751,11 @@ 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" +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` You can return your tenant ID by running this command: -Get-CsTenant | Select-Object DisplayName, TenantID +`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. @@ -441,53 +771,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -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: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi +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 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 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSmartCompose -Turn on this setting to let a user get text predictions for chat messages. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False -Position: Con nombre +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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-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 f14841afe0..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://learn.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 81% rename from skype/skype-ps/skype/Set-CsTeamsNetworkRoamingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsNetworkRoamingPolicy.md index 669b8e9147..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://learn.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 @@ -30,7 +35,7 @@ The TeamsNetworkRoamingPolicy cmdlets enable administrators to provide specific 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 81% rename from skype/skype-ps/skype/Set-CsTeamsPinnedApp.md rename to teams/teams-ps/teams/Set-CsTeamsPinnedApp.md index 0caffa9313..fac26286e2 100644 --- a/skype/skype-ps/skype/Set-CsTeamsPinnedApp.md +++ b/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md @@ -1,19 +1,19 @@ --- external help file: Microsoft.Rtc.Management.dll-help.xml online version: https://learn.microsoft.com/powershell/module/skype/set-csteamspinnedapp -applicable: Skype for Business Online +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. @@ -34,7 +34,7 @@ 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. @@ -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 0c720ffaf2..eb62460fc0 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md @@ -2,7 +2,7 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: Set-CsTeamsShiftsConnectionInstance -author: lespina +author: leonardospina ms.author: lespina manager: valk online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance @@ -17,166 +17,101 @@ This cmdlet updates a Shifts connection instance. ## SYNTAX ### Set (Default) -``` -Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch - -Body [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch -Body +[-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] +[-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### SetExpanded -``` -Set-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch -ConnectorId - -ConnectorSpecificSettings -DesignatedActorId - -EnabledConnectorScenario -EnabledWfiScenario -Name -SyncFrequencyInMin - [-ConnectorAdminEmail ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] +```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] [] ``` ### SetViaIdentityExpanded -``` -Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch - -ConnectorId -ConnectorSpecificSettings - -DesignatedActorId -EnabledConnectorScenario -EnabledWfiScenario -Name - -SyncFrequencyInMin [-ConnectorAdminEmail ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] +```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 -``` -Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch - -Body [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch -Body [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ## 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. Note that the update allows for, but does not require, the -ConnectorSpecificSettings.LoginPwd and ConnectorSpecificSettings.LoginUserNameusername to be included. +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 WFM 1 -```powershell -PS C:\> $result = Set-CsTeamsShiftsConnectionInstance - -ConnectorInstanceId "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3" ` - -ConnectorId "6A51B888-FF44-4FEA-82E1-839401E00000" ` - -ConnectorAdminEmail "admin@contoso.com", "superadmin@contoso.com" ` - -DesignatedActorId "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8" ` - -EnabledConnectorScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ` - -EnabledWfiScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ` - -Name "My Connector Instance" ` - -SyncFrequencyInMin 10 ` - -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" - })` - -IfMatch "\"0a005fd6-0000-0d00-0000-60a76dbf1234\"" - -PS C:\> $result.ToJsonString() -``` -```output - -{ - "id": "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3", - "tenantId": "113B4CBF-77D6-4456-AC4B-6A17EBD07EF8", - "name": "My Connector Instance", - "connector": { - "id": "6A51B888-FF44-4FEA-82E1-839401E00000", - "name": "WFM 1" - }, - "connectorSpecificSettings": { - "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" - }, - "enabledConnectorScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "workforceIntegrationId": "WFI_8dbddbb0-6cba-4861-a541-192320cc0e88", - "enabledWfiScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "syncFrequencyInMin": 10, - "designatedActorId": "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8", - "etag": "\"0a005fd6-0000-0d00-0000-60a76dbf0000\"" - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ] -} - -``` - - -Updates the instance with the specified -ConnectorInstanceId. Returns the object of updated connector instance. - -In case of error, we can capture the error response as following: +### Example 1 -* 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 WFM 2 ```powershell +PS C:\> $connectionInstance = Get-CsTeamsShiftsConnectionInstance -ConnectorInstanceId WCI-eba2865f-6cac-46f9-8733-e0631a4536e1 PS C:\> $result = Set-CsTeamsShiftsConnectionInstance ` - -ConnectorInstanceId "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3" ` - -ConnectorId "95BF2848-2DDA-4425-B0EE-D62AEED00000" ` - -ConnectorAdminEmail "admin@contoso.com", "superadmin@contoso.com" ` - -DesignatedActorId "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8" ` - -EnabledConnectorScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ` - -EnabledWfiScenario "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ` - -Name "My Connector Instance" ` - -SyncFrequencyInMin 10 ` - -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" - }) ` - -IfMatch "\"0a005fd6-0000-0d00-0000-60a76dbf2345\"" + -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-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3", - "tenantId": "113B4CBF-77D6-4456-AC4B-6A17EBD07EF8", - "name": "My Connector Instance", - "connector": { - "id": "95BF2848-2DDA-4425-B0EE-D62AEED00000", - "name": "WFM 2" - }, - "connectorSpecificSettings": { - apiUrl = "https://contoso.com/api" - ssoUrl = "https://contoso.com/sso" - clientId = "myClientId" - }, - "enabledConnectorScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "workforceIntegrationId": "WFI_8dbddbb0-6cba-4861-a541-192320cc0e88", - "enabledWfiScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "syncFrequencyInMin": 10, - "designatedActorId": "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8", - "etag": "\"0a005fd6-0000-0d00-0000-60a76dbf0000\"" - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ] + "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 the specified -ConnectorInstanceId. Returns the object of updated 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: @@ -186,17 +121,15 @@ In case of error, we can capture the error response as following: * To get the error object and object details: `$result, $result.Detail` - ## PARAMETERS ### -Body -The request body +The request body ```yaml Type: IConnectorInstanceRequest Parameter Sets: Set, SetViaIdentity Aliases: - Required: True Position: Named Default value: None @@ -211,7 +144,6 @@ Wait for .NET debugger to attach Type: SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -226,7 +158,6 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -241,7 +172,6 @@ Gets or sets the list of connector admin email addresses. Type: String[] Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: - Required: False Position: Named Default value: None @@ -249,14 +179,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorId -The connector id +### -ConnectorInstanceId +The Id of the connector instance to be updated. ```yaml Type: String -Parameter Sets: SetExpanded, SetViaIdentityExpanded +Parameter Sets: SetExpanded, Set Aliases: +Required: True +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: SetExpanded, SetViaIdentityExpanded +Aliases: Required: True Position: Named Default value: None @@ -264,14 +207,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorInstanceId -The connector instance id +### -DesignatedActorId +Gets or sets the designated actor ID that App acts as for Shifts Graph API calls. ```yaml Type: String -Parameter Sets: Set, SetExpanded +Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: +Required: True +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: SetExpanded, SetViaIdentityExpanded +Aliases: Required: True Position: Named Default value: None @@ -279,14 +235,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -The connector specific settings +### -SyncScenarioOpenShift +The sync state for the open shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: IConnectorInstanceRequestConnectorSpecificSettings +Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded 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: SetExpanded, SetViaIdentityExpanded +Aliases: Required: True Position: Named Default value: None @@ -294,14 +263,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignatedActorId -Gets or sets the designated actor id that App acts as for Shifts Graph Api calls. +### -SyncScenarioShift +The sync state for the shift scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded 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: SetExpanded, SetViaIdentityExpanded +Aliases: Required: True Position: Named Default value: None @@ -309,14 +291,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledConnectorScenario -The connector enabled scenarios that are synced from WFM system to Shifts in MS Teams. +### -SyncScenarioTimeCard +The sync state for the time card scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: String[] +Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded 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: SetExpanded, SetViaIdentityExpanded +Aliases: Required: True Position: Named Default value: None @@ -324,14 +319,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledWfiScenario -The WFI enabled scenarios that are synced from Shifts in MS Teams to WFM system. +### -SyncScenarioTimeOffRequest +The sync state for the time off request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: String[] +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: SetExpanded, SetViaIdentityExpanded +Aliases: Required: True Position: Named Default value: None @@ -340,13 +348,12 @@ Accept wildcard characters: False ``` ### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +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 @@ -355,13 +362,12 @@ Accept wildcard characters: False ``` ### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +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 @@ -370,13 +376,12 @@ Accept wildcard characters: False ``` ### -IfMatch -The value of the etag field as returned by the cmdlets +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 @@ -385,13 +390,12 @@ Accept wildcard characters: False ``` ### -InputObject -Identity Parameter +Identity Parameter. ```yaml Type: IConfigApiBasedCmdletsIdentity Parameter Sets: SetViaIdentityExpanded, SetViaIdentity Aliases: - Required: True Position: Named Default value: None @@ -406,7 +410,6 @@ The connector instance name. Type: String Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: - Required: True Position: Named Default value: None @@ -415,13 +418,12 @@ Accept wildcard characters: False ``` ### -Proxy -The URI for the proxy server to use +The URI for the proxy server to use. ```yaml Type: Uri Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -430,13 +432,12 @@ Accept wildcard characters: False ``` ### -ProxyCredential -Credentials for a proxy server to use for the remote call +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 @@ -445,13 +446,12 @@ Accept wildcard characters: False ``` ### -ProxyUseDefaultCredentials -Use the default credentials for the proxy +Use the default credentials for the proxy. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -459,6 +459,20 @@ 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: SetExpanded, SetViaIdentityExpanded +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SyncFrequencyInMin The sync frequency in minutes. @@ -466,7 +480,6 @@ The sync frequency in minutes. Type: Int32 Parameter Sets: SetExpanded, SetViaIdentityExpanded Aliases: - Required: True Position: Named Default value: None @@ -482,6 +495,20 @@ The cmdlet is not run. 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: Required: False Position: Named @@ -509,12 +536,12 @@ 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) -[New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) -[Update-CsTeamsShiftsConnectionInstance](Update-CsTeamsShiftsConnectionInstance.md) +[Update-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) +[Remove-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnectioninstance) -[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.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 22c05c02a1..6835a0dfa9 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsPolicy.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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,23 +66,8 @@ 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. @@ -91,7 +78,6 @@ The warning message is shown in the blocking dialog when a user access Teams off '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 5f950ddae6..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://learn.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 142f21993c..75ea8483a8 100644 --- a/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/teams/Set-CsTeamsUnassignedNumberTreatment.md @@ -3,11 +3,12 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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,7 +16,6 @@ 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 ``` @@ -74,7 +74,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 @@ -150,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://learn.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 cc11750dae..e39d07bd9a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsVoiceApplicationsPolicy.md @@ -1,7 +1,8 @@ --- external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsvoiceapplicationspolicy +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsvoiceapplicationspolicy +title: Set-CsTeamsVoiceApplicationsPolicy schema: 2.0.0 --- @@ -14,24 +15,52 @@ Modifies an existing Teams voice applications policy. ## SYNTAX ``` -Set-CsTeamsVoiceApplicationsPolicy [-AllowAutoAttendantAfterHoursGreetingChange ] +Set-CsTeamsVoiceApplicationsPolicy [-AllowAutoAttendantBusinessHoursGreetingChange ] - [-AllowAutoAttendantHolidayGreetingChange ] [-AllowAutoAttendantBusinessHoursChange ] [-AllowAutoAttendantTimeZoneChange ] [-AllowAutoAttendantLanguageChange ] [-AllowAutoAttendantHolidaysChange ] [-AllowAutoAttendantBusinessHoursRoutingChange ] [-AllowAutoAttendantAfterHoursRoutingChange ] - [-AllowAutoAttendantHolidayRoutingChange ] [-AllowCallQueueMusicOnHoldChange ] + [-AllowAutoAttendantAfterHoursGreetingChange ] + [-AllowAutoAttendantHolidayGreetingChange ] + [-AllowAutoAttendantBusinessHoursChange ] + [-AllowAutoAttendantHolidaysChange ] + [-AllowAutoAttendantTimeZoneChange ] + [-AllowAutoAttendantLanguageChange ] + [-AllowAutoAttendantBusinessHoursRoutingChange ] + [-AllowAutoAttendantAfterHoursRoutingChange ] + [-AllowAutoAttendantHolidayRoutingChange ] + + [-AllowCallQueueWelcomeGreetingChange ] + [-AllowCallQueueMusicOnHoldChange ] [-AllowCallQueueOverflowSharedVoicemailGreetingChange ] [-AllowCallQueueTimeoutSharedVoicemailGreetingChange ] - [-AllowCallQueueWelcomeGreetingChange ] [-AllowCallQueueOptOutChange ] [-AllowCallQueueAgentOptChange ] [-AllowCallQueueMembershipChange ] [-AllowCallQueueRoutingMethodChange ] [-AllowCallQueuePresenceBasedRoutingChange ] + [-AllowCallQueueNoAgentSharedVoicemailGreetingChange ] + [-AllowCallQueueLanguageChange ] + [-AllowCallQueueMembershipChange ] + [-AllowCallQueueConferenceModeChange ] + [-AllowCallQueueRoutingMethodChange ] + [-AllowCallQueuePresenceBasedRoutingChange ] + [-AllowCallQueueOptOutChange ] + [-AllowCallQueueOverflowRoutingChange ] + [-AllowCallQueueTimeoutRoutingChange ] + [-AllowCallQueueNoAgentsRoutingChange ] + [-AllowCallQueueAgentOptChange ] + [-CallQueueAgentMonitorMode ] [-CallQueueAgentMonitorNotificationMode ] - [-AllowCallQueueLanguageChange ] [-AllowCallQueueOverflowRoutingChange ] - [-AllowCallQueueTimeoutRoutingChange ] [-AllowCallQueueNoAgentsRoutingChange ] - [-AllowCallQueueConferenceModeChange ] [[-Identity] ] + + [-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 @@ -45,9 +74,9 @@ The command shown in Example 1 sets allowing CQ overflow shared voicemail greeti ## PARAMETERS -### -AllowAutoAttendantAfterHoursGreetingChange +### -AllowAutoAttendantBusinessHoursGreetingChange -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. +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 @@ -61,9 +90,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantBusinessHoursGreetingChange +### -AllowAutoAttendantAfterHoursGreetingChange -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. +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 @@ -79,7 +108,7 @@ 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 @@ -95,7 +124,7 @@ 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 will not be allowed to change the auto attendant's business hours schedule. +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 @@ -109,9 +138,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantTimeZoneChange +### -AllowAutoAttendantHolidaysChange -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 will not be allowed to change the auto attendant's time zone. +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 @@ -125,9 +154,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantLanguageChange +### -AllowAutoAttendantTimeZoneChange -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 will not be allowed to change the auto attendant's language. +_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 @@ -141,9 +172,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAutoAttendantHolidaysChange +### -AllowAutoAttendantLanguageChange -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 will not be allowed to change the auto attendant's holiday schedules. +_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 @@ -159,7 +192,7 @@ 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 will not be allowed to change the auto attendant's business hours call flow. +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 @@ -175,7 +208,7 @@ 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 will not be allowed to change the auto attendant's after-hours call flow. +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 @@ -191,7 +224,23 @@ 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 will not be allowed to change the auto attendant's holiday call flows. +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 @@ -207,7 +256,7 @@ 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 @@ -223,7 +272,7 @@ 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 @@ -239,7 +288,7 @@ 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 @@ -253,9 +302,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueWelcomeGreetingChange +### -AllowCallQueueNoAgentSharedVoicemailGreetingChange -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. +_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 @@ -269,9 +320,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOptOutChange +### -AllowCallQueueLanguageChange -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 will not be allowed to change the call queue opt-out setting. +_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 @@ -285,11 +338,9 @@ 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 will not be allowed to change an agent's opt-in status in the call queue. +### -AllowCallQueueMembershipChange -Note that the call queue must be configured to allow agents to opt out in order for this option to work. +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 @@ -303,9 +354,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueMembershipChange +### -AllowCallQueueConferenceModeChange -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 will not be allowed to change the call queue's users. +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 @@ -321,7 +372,7 @@ 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 will not be allowed to change the call queue's routing method. +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 @@ -337,7 +388,87 @@ 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 will not be allowed to change the call queue's presence-based routing option. +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 @@ -355,21 +486,21 @@ Accept wildcard characters: False PARAMVALUE: Disabled | Monitor | Whisper | Barge | Takeover -When set to Disabled (the default value), users affected by the policy will not be allowed to monitor call sessions. +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 `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 `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 `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. +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: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -382,13 +513,15 @@ Accept wildcard characters: False PARAMVALUE: Disabled | Agent -When set to Agent, users affected by the policy will be allowed to monitor agents during call sessions. When set to Disabled (the default value) users affected by the policy will not be allowed to monitor agents during call sessions. +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: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -397,82 +530,143 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueLanguageChange +### -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. -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 will not be allowed to change the call queue's language. +> [!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: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueOverflowRoutingChange +### -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 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 will not be allowed to change the call queue's overflow handling properties. +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: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueTimeoutRoutingChange +### -RealTimeAgentMetricsPermission -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 will not be allowed to change the call queue's timeout handling properties. +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: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueNoAgentsRoutingChange +### -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 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 will not be allowed to change the call queue's no-agent handling properties. +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: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallQueueConferenceModeChange +### -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 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 will not be allowed to change the call queue's conference mode. +When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: Object +Parameter Sets: Dual Aliases: +applicable: Microsoft Teams Required: False Position: Named -Default value: False +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 ``` @@ -487,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 @@ -548,10 +742,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 29e8e94b71..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://learn.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,6 +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 63% rename from skype/skype-ps/skype/Set-CsTenantMigrationConfiguration.md rename to teams/teams-ps/teams/Set-CsTenantMigrationConfiguration.md index 7c9c4f30db..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://learn.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,14 +19,24 @@ 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 @@ -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://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://learn.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 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 62% rename from skype/skype-ps/skype/Set-CsTenantNetworkSite.md rename to teams/teams-ps/teams/Set-CsTenantNetworkSite.md index 033d99f455..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://learn.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,18 +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 ] - [-EmergencyCallRoutingPolicy ] [-EmergencyCallingPolicy ] - [-NetworkRoamingPolicy ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### Instance -```powershell -Set-CsTenantNetworkSite [-Tenant ] [-Description ] [-NetworkRegionID ] - [-LocationPolicy ] [-EnableLocationBasedRouting ] [-OnlineVoiceRoutingPolicy ] - [-EmergencyCallRoutingPolicy ] [-EmergencyCallingPolicy ] - [-NetworkRoamingPolicy ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] +Set-CsTenantNetworkSite [[-Identity] ] [-Description ] [-EmergencyCallingPolicy ] [-EmergencyCallRoutingPolicy ] + [-EnableLocationBasedRouting ] [-LocationPolicy ] [-NetworkRegionID ] [-NetworkRoamingPolicy ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -40,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" ``` @@ -49,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" ``` @@ -65,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 @@ -95,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: @@ -110,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: @@ -125,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 ``` @@ -186,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. @@ -216,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 @@ -238,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 @@ -253,39 +206,8 @@ 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](/microsoftteams/manage-emergency-call-routing-policies#assign-a-custom-emergency-call-routing-policy-to-a-network-site). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -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](/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). - -```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 @@ -294,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 a3726a1fe0..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://learn.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 65222d6c90..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://learn.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 3959f7c23d..ac17aa7a8a 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingDelegate.md +++ b/teams/teams-ps/teams/Set-CsUserCallingDelegate.md @@ -3,11 +3,12 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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 6b53e83f90..4b590f4ab2 100644 --- a/teams/teams-ps/teams/Set-CsUserCallingSettings.md +++ b/teams/teams-ps/teams/Set-CsUserCallingSettings.md @@ -3,11 +3,12 @@ external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml Module Name: MicrosoftTeams 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 2d867ee8a4..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://learn.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 e8adb1b755..ec7260f07c 100644 --- a/teams/teams-ps/teams/Set-Team.md +++ b/teams/teams-ps/teams/Set-Team.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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,6 +415,6 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[Get-Team]() +[Get-Team](https://learn.microsoft.com/powershell/module/teams/get-team) -[New-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 485ea79f6e..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 +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 6f563ec114..14b6fa83e6 100644 --- a/teams/teams-ps/teams/Set-TeamChannel.md +++ b/teams/teams-ps/teams/Set-TeamChannel.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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-TeamPicture.md b/teams/teams-ps/teams/Set-TeamPicture.md index cd08747574..eeb537153b 100644 --- a/teams/teams-ps/teams/Set-TeamPicture.md +++ b/teams/teams-ps/teams/Set-TeamPicture.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 9cbe226369..4f8a952534 100644 --- a/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md +++ b/teams/teams-ps/teams/Set-TeamTargetingHierarchy.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: 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,9 +61,32 @@ 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 diff --git a/teams/teams-ps/teams/Set-TeamsApp.md b/teams/teams-ps/teams/Set-TeamsApp.md index 03dbd50d48..3f493249cb 100644 --- a/teams/teams-ps/teams/Set-TeamsApp.md +++ b/teams/teams-ps/teams/Set-TeamsApp.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams 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 66% rename from skype/skype-ps/skype/Start-CsExMeetingMigration.md rename to teams/teams-ps/teams/Start-CsExMeetingMigration.md index b67ce32d90..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://learn.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 @@ -157,8 +107,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [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/skype/get-csmeetingmigrationstatus) +[Get-CsMeetingMigrationStatus](https://learn.microsoft.com/powershell/module/teams/get-csmeetingmigrationstatus) -[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/skype/set-cstenantmigrationconfiguration) +[Set-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/set-cstenantmigrationconfiguration) -[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/skype/get-cstenantmigrationconfiguration) +[Get-CsTenantMigrationConfiguration](https://learn.microsoft.com/powershell/module/teams/get-cstenantmigrationconfiguration) diff --git a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md similarity index 61% rename from skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md rename to teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md index 463e7e9971..8076e411c3 100644 --- a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md @@ -1,29 +1,28 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/sync-csonlineapplicationinstance -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance +applicable: Microsoft Teams title: Sync-CsOnlineApplicationInstance schema: 2.0.0 -author: xixian73 -ms.author: xixian -manager:naveenv +author: serdarsoysal +ms.author: serdars +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. 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. +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 [-CallbackUri ] [-ObjectId ] [-ApplicationId ] [-Force] [-WhatIf] [-Confirm] - [] +Sync-CsOnlineApplicationInstance -ObjectId [-CallbackUri ] [-Force] [-ApplicationId ] [-AcsResourceId ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Use the Sync-CsOnlineApplicationInstance cmdlet to sync application instances from Azure Active Directory into Agent Provisioning Service. +Use the Sync-CsOnlineApplicationInstance cmdlet to sync application instances from Microsoft Entra ID into Agent Provisioning Service. ## EXAMPLES @@ -42,7 +41,6 @@ This command is helpful when there's already a mapping in Agent Provisioning Ser 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 @@ -76,7 +74,22 @@ Accept wildcard characters: False ``` ### -ApplicationId -The application ID. +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 @@ -137,4 +150,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 + +## 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 f0d9f389c3..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://learn.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 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 86c0b0a8b0..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://learn.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 c04fdddc09..7d7fd3966d 100644 --- a/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md +++ b/teams/teams-ps/teams/Test-CsTeamsShiftsConnectionValidate.md @@ -23,7 +23,7 @@ Test-CsTeamsShiftsConnectionValidate -ConnectorId -ConnectorSpecificSet ## 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 @@ -107,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 62549af423..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://learn.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 fb185b9360..1682ef0ba6 100644 --- a/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md +++ b/teams/teams-ps/teams/Test-CsTeamsUnassignedNumberTreatment.md @@ -64,10 +64,10 @@ The cmdlet is available in Teams PS module 3.2.0-preview or later. ## RELATED LINKS -[New-CsTeamsUnassignedNumberTreatment](new-csteamsunassignednumbertreatment.md) +[New-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/new-csteamsunassignednumbertreatment) -[Get-CsTeamsUnassignedNumberTreatment](get-csteamsunassignednumbertreatment.md) +[Get-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/get-csteamsunassignednumbertreatment) -[Set-CsTeamsUnassignedNumberTreatment](set-csteamsunassignednumbertreatment.md) +[Set-CsTeamsUnassignedNumberTreatment](https://learn.microsoft.com/powershell/module/teams/set-csteamsunassignednumbertreatment) -[Remove-CsTeamsUnassignedNumberTreatment](remove-csteamsunassignednumbertreatment.md) +[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 57ba162a5a..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://learn.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 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 b11fe86ba8..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://learn.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 3f6d684f4a..b993377f9a 100644 --- a/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md +++ b/teams/teams-ps/teams/Update-CsCustomPolicyPackage.md @@ -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://learn.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://learn.microsoft.com/powershell/module/skype/get-csteamsmeetingpolicy?view=skype-ps) and [Get-CsTeamsMessagingPolicy](https://learn.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 9030387a53..67710e31ba 100644 --- a/teams/teams-ps/teams/Update-CsTeamTemplate.md +++ b/teams/teams-ps/teams/Update-CsTeamTemplate.md @@ -5,7 +5,7 @@ online version: https://learn.microsoft.com/powershell/module/teams/update-cstea 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. @@ -801,7 +803,7 @@ MESSAGINGSETTING \: Governs use of messaging features w ## RELATED LINKS - [Get-CsTeamTemplateList](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplatelist) -- [Get-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/get-csteamtemplate) -- [New-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamtemplate) -- [Update-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/update-csteamtemplate) -- [Remove-CsTeamTemplate](https://learn.microsoft.com/powershell/module/teams/remove-csteamtemplate) +- [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 index 8d0be78396..466a0bf1c7 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md @@ -17,136 +17,90 @@ This cmdlet updates Shifts connection instance fields. ## SYNTAX ### Update (Default) -``` -Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch - -Body [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch -Body [-Break] +[-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] +[-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### UpdateExpanded -``` -Update-CsTeamsShiftsConnectionInstance -ConnectorInstanceId -IfMatch - [-ConnectorSpecificSettings ] [-DesignatedActorId ] - [-EnabledConnectorScenario ] [-EnabledWfiScenario ] [-Name ] [-SyncFrequencyInMin ] - [-ConnectorAdminEmail ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] +```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 -``` -Update-CsTeamsShiftsConnectionInstance -InputObject -IfMatch - [-ConnectorSpecificSettings ] - [-DesignatedActorId ] [-EnabledConnectorScenario ] [-EnabledWfiScenario ] [-Name ] - [-SyncFrequencyInMin ] [-ConnectorAdminEmail ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```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 -``` -Update-CsTeamsShiftsConnectionInstance -InputObject -IfMatch - -Body [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] +```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 Update-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. +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-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3" ` - -IfMatch "`"0a005fd6-0000-0d00-0000-60a76dbf1234`"" ` - -Name "My Connector Instance Renamed" ` - -SyncFrequencyInMin 15 + -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 { - "id": "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3", - "tenantId": "113B4CBF-77D6-4456-AC4B-6A17EBD07EF8", - "name": "My Connector Instance Renamed", - "connector": { - "id": "6A51B888-FF44-4FEA-82E1-839401E00000", - "name": "WFM 1" - }, - "connectorSpecificSettings": { - "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" - }, - "enabledConnectorScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "workforceIntegrationId": "WFI_8dbddbb0-6cba-4861-a541-192320cc0e88", - "enabledWfiScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "syncFrequencyInMin": 15, - "designatedActorId": "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8", - "etag": "\"0a005fd6-0000-0d00-0000-60a76dbf0000\"" - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ] + "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. -### Example 2 -```powershell -PS C:\> $result = Update-CsTeamsShiftsConnectionInstance ` - -ConnectorInstanceId "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3" ` - -IfMatch "`"0a005fd6-0000-0d00-0000-60a76dbf2345`"" ` - -ConnectorSpecificSettings (New-Object Microsoft.Teams.ConfigAPI.Cmdlets.Generated.Models.ConnectorSpecificUkgDimensionsSettingsRequest ` - -Property @{ - apiUrl = "https://contoso.com/api/new_endpoint/" - }) - - -PS C:\> $result.ToJsonString() -``` -```output - -{ - "id": "WCI-C6B1949E-FBA3-4374-B6F8-8BD2D4A255F3", - "tenantId": "113B4CBF-77D6-4456-AC4B-6A17EBD07EF8", - "name": "My Connector Instance", - "connector": { - "id": "95BF2848-2DDA-4425-B0EE-D62AEED00000", - "name": "WFM 2" - }, - "connectorSpecificSettings": { - apiUrl = "https://contoso.com/api/new_endpoint" - ssoUrl = "https://contoso.com/sso" - clientId = "myClientId" - }, - "enabledConnectorScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "workforceIntegrationId": "WFI_8dbddbb0-6cba-4861-a541-192320cc0e88", - "enabledWfiScenarios": [ "shift", "swapRequest", "openShift", "openShiftRequest", "timeOff", "timeOffRequest", "timeCard" ], - "syncFrequencyInMin": 10, - "designatedActorId": "C5A60335-9FBD-4E4E-B3AE-1F2E7E5E92E8", - "etag": "\"0a005fd6-0000-0d00-0000-60a76dbf0000\"" - "connectorAdminEmails": [ "admin@contoso.com", "superadmin@contoso.com" ] -} -``` - -Updates the instance with the specified -ConnectorInstanceId with the new API URL. Returns the object of the updated connector instance. - -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` - - ## PARAMETERS ### -Body @@ -156,7 +110,6 @@ The request body. Type: IUpdateConnectorInstanceFieldsRequest Parameter Sets: Update, UpdateViaIdentity Aliases: - Required: True Position: Named Default value: None @@ -171,7 +124,6 @@ Wait for the .NET debugger to attach. Type: SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -186,7 +138,6 @@ Prompts you for confirmation before running the cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf - Required: False Position: Named Default value: None @@ -201,7 +152,6 @@ Gets or sets the list of connector admin email addresses. Type: String[] Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: - Required: False Position: Named Default value: None @@ -216,7 +166,20 @@ The connector instance ID. 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 @@ -224,60 +187,126 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectorSpecificSettings -The connector-specific settings. +### -SyncScenarioOfferShiftRequest +The sync state for the offer shift request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: IUpdateConnectorInstanceFieldsRequestConnectorSpecificSettings +Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -Required: 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 ``` -### -DesignatedActorId -The designated actor ID that App acts as for Shifts Graph API calls. +### -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 +``` -Required: 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 ``` -### -EnabledConnectorScenario -The connector-enabled scenarios that are synced from the WFM system to Shifts in Microsoft Teams. +### -SyncScenarioSwapRequest +The sync state for the shift swap request scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: String[] +Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -Required: 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 ``` -### -EnabledWfiScenario -The WFI-enabled scenarios that are synced from Shifts in Microsoft Teams to the WFM system. +### -SyncScenarioTimeOff +The sync state for the time off scenario. Valid values are "Disabled", "FromWfmToShifts", and "TwoWay". ```yaml -Type: String[] +Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -Required: 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 @@ -291,7 +320,6 @@ SendAsync Pipeline Steps to be appended to the front of the pipeline. Type: SendAsyncStep[] Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -306,7 +334,6 @@ SendAsync Pipeline Steps to be prepended to the front of the pipeline. Type: SendAsyncStep[] Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -321,7 +348,6 @@ The value of the ETag field as returned by the cmdlets. Type: String Parameter Sets: (All) Aliases: - Required: True Position: Named Default value: None @@ -336,7 +362,6 @@ Identity Parameter Type: IConfigApiBasedCmdletsIdentity Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: - Required: True Position: Named Default value: None @@ -351,7 +376,6 @@ The connector instance name. Type: String Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: - Required: False Position: Named Default value: None @@ -366,7 +390,6 @@ The URI for the proxy server to use. Type: Uri Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -381,7 +404,6 @@ Credentials for a proxy server to use for the remote call. Type: PSCredential Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -396,7 +418,6 @@ Use the default credentials for the proxy. Type: SwitchParameter Parameter Sets: (All) Aliases: - Required: False Position: Named Default value: None @@ -404,6 +425,20 @@ 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. @@ -411,7 +446,6 @@ The sync frequency in minutes. Type: Int32 Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: - Required: False Position: Named Default value: None @@ -427,6 +461,36 @@ The cmdlet is not run. 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 @@ -454,13 +518,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) - -[New-CsTeamsShiftsConnectionInstance](New-CsTeamsShiftsConnectionInstance.md) +[Get-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnectioninstance) -[Set-CsTeamsShiftsConnectionInstance](Set-CsTeamsShiftsConnectionInstance.md) +[New-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnectioninstance) -[Remove-CsTeamsShiftsConnectionInstance](Remove-CsTeamsShiftsConnectionInstance.md) +[Set-CsTeamsShiftsConnectionInstance](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnectioninstance) -[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) +[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 a86a41a375..d7ce547680 100644 --- a/teams/teams-ps/teams/Update-TeamsAppInstallation.md +++ b/teams/teams-ps/teams/Update-TeamsAppInstallation.md @@ -2,6 +2,7 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/update-teamsappinstallation +title: Update-TeamsAppInstallation schema: 2.0.0 author: serdarsoysal ms.author: serdars @@ -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 9409d858c4..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://learn.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 ef633517fe..058504f325 100644 --- a/teams/teams-ps/teams/teams.md +++ b/teams/teams-ps/teams/teams.md @@ -12,178 +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) -{{Manually Enter Get-AssociatedTeam Description Here}} - +### [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) -{{Manually Enter Get-SharedWithTeam Description Here}} - ### [Get-SharedWithTeamUser](Get-SharedWithTeamUser.md) -{{Manually Enter Get-SharedWithTeamUser Description Here}} - ### [Get-Team](Get-Team.md) -{{Manually Enter Get-Team Description Here}} - ### [Get-TeamAllChannel](Get-TeamAllChannel.md) -{{Manually Enter Get-TeamAllChannel Description Here}} - ### [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) -{{Manually Enter Get-TeamIncomingChannel Description Here}} - ### [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}} - -### [Get-CsCloudCallDataConnection](Get-CsCloudCallDataConnection.md) -This cmdlet retrieves an already existing online call data connection. - +### [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) -Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview. - -### [Grant-TeamsEnhancedEncryptionPolicy](Grant-TeamsEnhancedEncryptionPolicy.md) -Cmdlet to assign a specific Teams enhanced encryption policy to a user. - +### [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) -This cmdlet allows you to create a new TeamsEventsPolicy instance and set it's properties. Note that this policy is currently still in preview. - +### [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}} - -### [New-CsCloudCallDataConnection](New-CsCloudCallDataConnection.md) -This cmdlet creates an online call data connection. - -### [Remove-CsTeamsEventsPolicy](Remove-CsTeamsEventsPolicy) -Removes a previously created TeamsEventsPolicy. Note that this policy is currently still in preview. - +### [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) -{{Manually Enter Remove-SharedWithTeam Description Here}} - ### [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) -Allows you to configure options for customizing Teams Events experiences. Note that this policy is currently still in preview. - +### [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) -This cmdlet updates Shifts connection instance fields. +### [Update-CsTeamTemplate](Update-CsTeamTemplate.md) +### [Update-M365UnifiedCustomPendingApp](Update-M365UnifiedCustomPendingApp.md) +### [Update-TeamsAppInstallation](Update-TeamsAppInstallation.md) 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 ca0223451d..a533b03ca5 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md +++ b/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md @@ -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 index 32755f75ce..531dc66db0 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md @@ -14,26 +14,26 @@ ms.reviewer: ## SYNOPSIS -Gets all the whiteboards associated with a tenant in a specified geography. +Gets all the whiteboards in Azure associated with a tenant in a specified geography. ## SYNTAX ```powershell -Get-WhiteboardsForTenant [-Geography ] - [-IncrementalRunName ] - [-ForceAuthPrompt] - [] +Get-WhiteboardsForTenant [-Geography ] + [-IncrementalRunName ] + [-ForceAuthPrompt] + [] ``` ## DESCRIPTION -Gets all the whiteboards 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. +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 associated with the caller's tenant in Europe as a list of whiteboard metadata objects. +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 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/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-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 bba8102aea..ba9d6b6572 100644 --- a/whiteboard/whiteboard-ps/whiteboard/whiteboard.md +++ b/whiteboard/whiteboard-ps/whiteboard/whiteboard.md @@ -10,11 +10,21 @@ title: Microsoft Whiteboard 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) @@ -22,7 +32,23 @@ Gets all the users in a tenant who own whiteboards in a specified geography. ### [Get-WhiteboardsForTenant](Get-WhiteboardsForTenant.md) -Gets all the whiteboards associated with a tenant in a specified geography. +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) @@ -35,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.