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 33c626c669..0c2327fa83 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -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 }, { @@ -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 }, { @@ -6944,6 +6944,2083 @@ "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/README.md b/README.md index 5127ebae82..799d11a6c6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ --- -ms.date: 9/15/2023 +ms.date: 05/16/2025 --- # Overview @@ -8,9 +8,11 @@ ms.date: 9/15/2023 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 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://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. @@ -21,26 +23,30 @@ Contributors who make infrequent or small updates can edit the file directly on 2. On learn.microsoft.com, find the article that you want to update. 3. Above the title of the article, select ![Edit this document icon.](images/m365-cc-sc-edit-icon.png) **Edit this document**. - ![Edit this document button on a learn.microsoft.com article.](images/quick-update-edit-button-on-learn-page.png) + ![Screenshot of how to select the Edit this document button on a learn.microsoft.com article.](images/quick-update-edit-button-on-learn-page.png) + +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) -4. The corresponding article file opens on GitHub. Select ![Edit this file icon.](images/m365-cc-sc-edit-icon.png) **Edit this file**. +5. If a **You need to fork this repository to propose changes** page opens, select **Fork this repository**. - ![Edit this document button on a GitHub article file.](images/quick-update-edit-button-on-github-page.png) + ![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) -5. The article file opens in a line-numbered editor page where you can make updates. +6. The article file opens in a line-numbered editor page where you can make updates. 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/). > [!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 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). Select **Preview** to view your changes as you go. Select **Edit** to go back to making updates. When you're finished making changes, select the green **Commit changes** button. - ![Select the green Commit changes button on the article editor page.](images/quick-update-editor-page.png) + ![Screenshot of how to select the green Commit changes button on the article editor page.](images/quick-update-editor-page.png) -6. In the **Propose changes** dialog that opens, review and/or enter the following values: +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. @@ -48,17 +54,17 @@ Contributors who make infrequent or small updates can edit the file directly on When you're finished on the **Propose changes** dialog, select the green **Propose changes** button. - ![Select the green Propose changes button in the Propose changes dialog.](images/quick-update-propose-changes-dialog.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 opens, select the green **Create pull request** button. +8. On the **Comparing changes** page that opens, select the green **Create pull request** button. - ![Select the green Create pull request button on the Comparing changes page.](images/quick-update-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 opens, review the title and comments, and then select 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. - ![Select the green Create pull request button on the Open a pull request page.](images/quick-update-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) -9. That's it. There's nothing more for you to do. +10. That's it. There's nothing more for you to do. 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. diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index dbb7afa76d..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: 8/25/2023 +manager: deniseb +ms.date: 12/12/2023 ms.audience: Admin audience: Admin ms.topic: article @@ -33,7 +33,7 @@ Certificate based authentication (CBA) or app-only authentication as described i > > For instructions on how to install or update the module, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). For instructions on how to use the module in Azure automation, see [Manage modules in Azure Automation](/azure/automation/shared-resources/modules). > -> - REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-based-connections-in-windows). +> - 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`. > @@ -45,6 +45,11 @@ Certificate based authentication (CBA) or app-only authentication as described i > > You can use Microsoft Graph to replace most of the functionality from those cmdlets. For more information, see [Working with groups in Microsoft Graph](/graph/api/resources/groups-overview). > +> - In Security & Compliance PowerShell, you can't use the procedures in this article with the following Microsoft 365 Group cmdlets: +> - [Get-ComplianceSearchAction](/powershell/module/exchange/get-compliancesearchaction) +> - [New-ComplianceSearch](/powershell/module/exchange/new-compliancesearch) +> - [Start-ComplianceSearch](/powershell/module/exchange/start-compliancesearch) +> > - Delegated scenarios are supported in Exchange Online. The recommended method for connecting with delegation is using GDAP and App Consent. For more information, see [Use the Exchange Online PowerShell v3 Module with GDAP and App Consent](/powershell/partnercenter/exchange-online-gdap-app). You can also use multi-tenant applications when CSP relationships are not created with the customer. The required steps for using multi-tenant applications are called out within the regular instructions in this article. > > - Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet if you get the following error when using the Windows PowerShell SDK to connect: `The term 'Update-ModuleManifest' is not recognized as a name of a cmdlet, function, script file, or executable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again.` @@ -62,8 +67,6 @@ 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: > -> Remote PowerShell connections are deprecated in Exchange Online PowerShell and will be deprecated in 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). -> > - 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`. @@ -126,11 +129,11 @@ 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. For more information, see [Application and service principal objects in Microsoft Entra ID](/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 Microsoft Entra ID, see . -1. [Register the application in Microsoft Entra ID](#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). @@ -147,18 +150,16 @@ For a detailed visual flow about creating applications in Microsoft Entra ID, se > [!NOTE] > Cryptography: Next Generation (CNG) certificates aren't supported for app-only authentication with Exchange. CNG certificates are created by default in modern versions of Windows. You must use a certificate from a CSP key provider. [This section](#step-3-generate-a-self-signed-certificate) section covers two supported methods to create a CSP certificate. -4. [Attach the certificate to the Microsoft Entra 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 Microsoft Entra 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 Microsoft Entra ID, you can use any of the supported built-in roles. - - ### Step 1: Register the application in Microsoft Entra ID > [!NOTE] -> If you encounter problems, check the [required permissions](/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 Microsoft Entra admin center at . @@ -186,7 +187,7 @@ For a detailed visual flow about creating applications in Microsoft Entra ID, se - **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 native applications 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) @@ -215,15 +216,15 @@ Choose **one** of the following methods in this section to assign API permission ![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) -5. On the **What type of permissions does your application require?** flyout that appears, select **Application permissions**. +4. On the **What type of permissions does your application require?** flyout that appears, select **Application permissions**. -6. In the permissions list that appears, expand **Exchange**, select **Exchange.ManageAsApp**, and then select **Add 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) -7. Back on the app **API permissions** page, verify **Office 365 Exchange Online** \> **Exchange.ManageAsApp** is listed and contains the following values: +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**. + - **Admin consent required**: **Yes**. - **Status**: The current incorrect value is **Not granted for \**. @@ -235,16 +236,16 @@ Choose **one** of the following methods in this section to assign API permission ![Admin consent granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-admin-consent-granted.png) -8. 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. +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) -9. 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. +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.Manage.AsApp** permissions in **Office 365 Exchange Online**. +> 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. @@ -309,7 +310,7 @@ Choose **one** of the following methods in this section to assign API permission 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**. + - **Admin consent required**: **Yes**. - **Status**: The current incorrect value is **Not granted for \** for the **Office 365 Exchange Online** \> **Exchange.ManageAsApp** entry. @@ -350,8 +351,6 @@ 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 Microsoft Entra application After you register the certificate with your application, you can use the private key (`.pfx` file) or the thumbprint for authentication. @@ -384,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` @@ -392,9 +391,7 @@ 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 Microsoft Entra roles to the application @@ -408,31 +405,31 @@ You have two options: > > For multi-tenant applications in **Exchange Online** delegated scenarios, you need to assign permissions in each customer tenant. - - #### Assign Microsoft Entra roles to the application 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. + +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 [View and assign administrator roles in Microsoft Entra ID](/azure/active-directory/roles/manage-roles-portal). +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. @@ -463,7 +460,7 @@ For general instructions about assigning roles in Microsoft Entra ID, see [View ![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) @@ -486,11 +483,11 @@ For general instructions about assigning roles in Microsoft Entra ID, see [View > > This method is supported only when you connect to Exchange Online PowerShell or Security & Compliance PowerShell in [REST API mode](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module). Security & Compliance PowerShell supports REST API mode in v3.2.0 or later. -For information about creating custom role groups, see [Create role groups in Exchange Online](/exchange/permissions-exo/role-groups#create-role-groups) and [Create Email & collaboration role groups in the Microsoft Defender portal](/microsoft-365/security/office-365-security/mdo-portal-permissions#create-email--collaboration-role-groups-in-the-microsoft-365-defender-portal). 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 role groups to the application using service principals, do the following steps: -1. In [Microsoft Graph PowerShell](/powershell/microsoftgraph/installation), run the following commands to store the details of the Microsoft Entra application that you registered in [Step 1](#step-1-register-the-application-in-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 Connect-MgGraph -Scopes AppRoleAssignment.ReadWrite.All,Application.Read.All 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 53369b5d77..bbd2cf89d9 100644 --- a/exchange/docs-conceptual/cmdlet-property-sets.md +++ b/exchange/docs-conceptual/cmdlet-property-sets.md @@ -2,7 +2,7 @@ title: Property sets in Exchange Online PowerShell module cmdlets ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 9/1/2023 ms.audience: Admin audience: Admin diff --git a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md index 16ce6b7dd2..2f484fd336 100644 --- a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md +++ b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md @@ -2,7 +2,7 @@ title: Use Azure managed identities to connect to Exchange Online PowerShell ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 8/24/2023 ms.audience: Admin audience: Admin @@ -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#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?](/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). @@ -35,7 +35,7 @@ The rest of this article explains how to connect using managed identity, and the > > 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-based-connections-in-windows). +> 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 @@ -56,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 Microsoft Entra 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 @@ -104,7 +104,7 @@ The rest of this section explains how to connect using supported Azure resources - A PowerShell runbook on the Azure Automation account with user-assigned managed identity. - An Azure VM with a user-assigned managed identity. -After the resource is connected, the Exchange Online PowerShell cmdlets and parameters are available based on the RBAC role you assigned in [Step 6: Assign Microsoft Entra roles to the managed identity](#step-6-assign-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 @@ -149,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 Microsoft Entra 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). @@ -217,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 @@ -333,8 +333,6 @@ For detailed syntax and parameter information, see the following articles: - [Get-MgServicePrincipal](/powershell/module/microsoft.graph.applications/get-mgserviceprincipal) - [New-MgServicePrincipalAppRoleAssignment](/powershell/module/microsoft.graph.applications/new-mgserviceprincipalapproleassignment) - - #### What to do if the Office 365 Exchange Online resource is not available in Microsoft Entra ID If the following command returns no results: @@ -345,7 +343,7 @@ Get-MgServicePrincipal -Filter "AppId eq '00000002-0000-0ff1-ce00-000000000000'" Do the following steps: -1. Register an application in Microsoft Entra ID as described in [Step 1: Register the application in Microsoft Entra ID](app-only-auth-powershell-v2.md#step-1-register-the-application-in-azure-ad). +1. Register an application in Microsoft Entra ID as described in [Step 1: Register the application in Microsoft Entra ID](app-only-auth-powershell-v2.md#step-1-register-the-application-in-microsoft-entra-id). 2. Assign the Office 365 Exchange Online \> Exchange.ManageAsApp API permission to the application using the "Modify the app manifest" method as described in [Step 2: Assign API permissions to the application](app-only-auth-powershell-v2.md#step-2-assign-api-permissions-to-the-application). After you do these steps, run the **Get-MgServicePrincipal** command again to confirm that the Office 365 Exchange Online resource is available in Microsoft Entra ID. @@ -358,29 +356,29 @@ Get-MgServicePrincipal -Filter "AppId eq '00000002-0000-0ff1-ce00-000000000000'" 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](/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) +- [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. +¹ The Global Administrator and Exchange Administrator roles provide the required permissions for any task in Exchange Online PowerShell. For example: -For general instructions about assigning roles in Microsoft Entra ID, see [View and assign administrator roles in Microsoft Entra ID](/azure/active-directory/roles/manage-roles-portal). +- 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. @@ -445,7 +443,7 @@ The steps are: 3. [Store the user-assigned managed identity in a variable](#step-3-store-the-user-assigned-managed-identity-in-a-variable) 4. [Add the Exchange Online PowerShell module to the managed identity](#step-4-add-the-exchange-online-powershell-module-to-the-managed-identity) 5. [Grant the Exchange.ManageAsApp API permission for the managed identity to call Exchange Online](#step-5-grant-the-exchangemanageasapp-api-permission-for-the-managed-identity-to-call-exchange-online) -6. [Assign Microsoft Entra roles to the managed identity](#step-6-assign-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). @@ -453,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: @@ -551,8 +549,8 @@ 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 @@ -588,11 +586,9 @@ 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 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 Microsoft Entra role to (not the automation account itself). diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index 1125420f8e..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: 8/21/2023 +manager: deniseb +ms.date: 05/07/2025 ms.audience: Admin audience: Admin ms.topic: article @@ -33,7 +33,7 @@ To connect to Exchange Online PowerShell from C#, see [Use C# to connect to Exch > [!NOTE] > Remote PowerShell connections are deprecated in Exchange Online PowerShell. For more information, see [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). > - > REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-based-connections-in-windows). + > 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). @@ -61,15 +61,13 @@ Import-Module ExchangeOnlineManagement The command that you need to run uses the following syntax: ```powershell -Connect-ExchangeOnline -UserPrincipalName [-ExchangeEnvironmentName ] [-ShowBanner:$false] [-DelegatedOrganization ] [-SkipLoadingFormatData] +Connect-ExchangeOnline -UserPrincipalName [-ExchangeEnvironmentName ] [-ShowBanner:$false] [-LoadCmdletHelp] [-DelegatedOrganization ] [-SkipLoadingFormatData] [-DisableWAM] ``` For detailed syntax and parameter information, see [Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline). - _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). -- 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). - - 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| @@ -82,6 +80,8 @@ 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. +- 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. + - 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. @@ -92,6 +92,8 @@ For detailed syntax and parameter information, see [Connect-ExchangeOnline](/pow - 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 @@ -237,7 +239,7 @@ If you receive errors, check the following requirements: > 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-based-connections-in-windows). + 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: 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 0e72c79e74..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,7 +1,7 @@ --- title: Connect to Exchange Online Protection PowerShell author: chrisda -manager: dansimp +manager: deniseb ms.date: 8/21/2023 ms.audience: Admin audience: Admin @@ -29,7 +29,7 @@ For more information about Exchange Online Protection PowerShell, see [Exchange > > 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-based-connections-in-windows). +> 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? 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 cdcf60b7da..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,7 +2,7 @@ title: "Connect to Exchange servers using remote PowerShell" ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 9/7/2023 ms.audience: ITPro audience: ITPro 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 d7c756745d..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,7 +2,7 @@ title: Use C# to connect to Exchange Online PowerShell ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 8/21/2023 ms.audience: Admin audience: Admin @@ -24,7 +24,7 @@ The code samples in this article use the [Exchange Online PowerShell V3 module]( 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-based-connections-in-windows). +> 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. diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md index 3916e61cd5..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: 11/7/2023 +manager: deniseb +ms.date: 05/07/2025 ms.audience: Admin audience: Admin ms.topic: article @@ -31,9 +31,9 @@ To connect to Security & Compliance PowerShell for automation, see [App-only aut > [!NOTE] > Remote PowerShell connections are deprecated in Security & Compliance PowerShell. For more information, see [Deprecation of Remote PowerShell (RPS) Protocol in Security & Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). > - > REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-based-connections-in-windows). + > 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 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 @@ -61,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). @@ -105,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**. @@ -171,8 +172,6 @@ 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, when you connect using remote PowerShell mode, you're limited to five open connections to Security & Compliance PowerShell. - - 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. @@ -181,7 +180,7 @@ If you receive errors, check the following requirements: > 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-based-connections-in-windows). + 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: 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 222d6dc944..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,7 +2,7 @@ title: "Control remote PowerShell access to Exchange servers" ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 9/7/2023 ms.audience: ITPro audience: ITPro 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 ee908a674d..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: 9/1/2023 +manager: deniseb +ms.date: 12/11/2024 ms.audience: Admin audience: Admin ms.topic: article @@ -18,7 +18,7 @@ description: "Admins can learn how to disable or enable access to Exchange Onlin Exchange Online PowerShell is the administrative interface that enables admins to manage the Exchange Online part of a Microsoft 365 organization from the command line (including many security features in Exchange Online Protection and Microsoft Defender for Office 365). -By default, all accounts in Microsoft 365 are allowed to use Exchange Online PowerShell. This access doesn't give users administrative capabilities in an organization. They're still limited by [role based access control (RBAC)](/exchange/permissions-exo/permissions-exo) (for example, they can configure settings on their own mailbox or manage distribution groups that they own). +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. @@ -30,12 +30,14 @@ Admins can use the procedures in this article to disable or enable a user's abil - 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 **Global Administrator** role. + - [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 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 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). @@ -44,24 +46,23 @@ Admins can use the procedures in this article to disable or enable a user's abil ## 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 @@ -71,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". @@ -79,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 @@ -89,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 $NoPS = Get-Content "C:\My Documents\NoPowerShell.txt" -$NoPS | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} +$NoPS | foreach {Set-User -Identity $_ -EXOModuleEnabled $false} ``` ## 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 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 3a2031a261..2d91c08839 100644 --- a/exchange/docs-conceptual/exchange-cmdlet-syntax.md +++ b/exchange/docs-conceptual/exchange-cmdlet-syntax.md @@ -2,7 +2,7 @@ title: "Exchange cmdlet syntax" ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 9/7/2023 ms.audience: Admin audience: Admin @@ -108,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 ( `''` ). diff --git a/exchange/docs-conceptual/exchange-management-shell.md b/exchange/docs-conceptual/exchange-management-shell.md index 6a85f2457d..f10d3cc542 100644 --- a/exchange/docs-conceptual/exchange-management-shell.md +++ b/exchange/docs-conceptual/exchange-management-shell.md @@ -2,7 +2,7 @@ title: "Exchange Server PowerShell (Exchange Management Shell)" ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 9/1/2023 ms.audience: ITPro audience: ITPro diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 4fb84929ea..5849e19153 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -2,8 +2,8 @@ title: About the Exchange Online PowerShell V3 module ms.author: chrisda author: chrisda -manager: dansimp -ms.date: 11/7/2023 +manager: deniseb +ms.date: 05/07/2025 ms.audience: Admin audience: Admin ms.topic: article @@ -38,22 +38,22 @@ The rest of this article explains how the module works, how to install and maint ## REST API connections in the EXO V3 module -All available cmdlets in Exchange Online PowerShell and [virtually all cmdlets](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432) in Security & Compliance PowerShell are backed by a REST API based on the version of the EXO V3 module: +Exchange Online PowerShell and Security & Compliance PowerShell now use REST API connections for all cmdlets: -- **Exchange Online PowerShell**: v3.0.0 or later. -- **Security & Compliance PowerShell**: v3.2.0 or later. +- **Exchange Online PowerShell**: EXO V3 module v3.0.0 or later. +- **Security & Compliance PowerShell**: EXO V3 module v3.2.0 or later. -In Exchange Online PowerShell and in Security & Compliance PowerShell, REST API connections are used by default and require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](#powershellget-for-rest-based-connections-in-windows). +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). -REST API cmdlets have the following advantages over their historical counterparts: +Cmdlets in REST API connections have the following advantages over their historical counterparts: -- **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). -- **More reliable**: REST API cmdlets handle transient failures with built-in retries, so failures or delays are minimized. For example: +- **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**: The connection avoids setting up a PowerShell runspace. +- **Better performance**: REST API connections avoid setting up a PowerShell runspace. -The benefits of REST API cmdlets are described in the following table: +The benefits of cmdlets in REST API connections are described in the following table: | |Remote PowerShell cmdlets|Get-EXO\* cmdlets|REST API cmdlets| |---|---|---|---| @@ -62,57 +62,52 @@ The benefits of REST API cmdlets are described in the following table: |**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 any of your scripts. +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). -Consider the following items for connections in remote PowerShell mode: - -- Remote PowerShell connections are deprecated in Exchange Online PowerShell and will be deprecated in 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). -- Remote PowerShell connections require [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm) on the client computer. If you don't connect in remote PowerShell mode, you have access to REST API cmdlets _only_. -- 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 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-based connections. +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** or **Connect-IPPSSession** command.|Returns nothing.| - |Run after a **Connect-ExchangeOnline** or **Connect-IPPSSession** command that connects in remote PowerShell mode.|Returns nothing (use [Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)).| - |Run after **Connect-ExchangeOnline** or **Connect-IPPSSession** command that connects in REST API mode.|Returns one connection information object.| - |Run after multiple REST-based **Connect-ExchangeOnline** or **Connect-IPPSSession** commands.|Returns a collection of connection information objects.| - |Run after multiple **Connect-ExchangeOnline** or **Connect-IPPSSession** commands that connect in remote PowerShell mode and REST API mode.|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 in REST-based connections to avoid loading format data and to run **Connect-ExchangeOnline** commands faster. +- Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet to avoid loading format data and to run **Connect-ExchangeOnline** commands faster. -- Cmdlets backed by the REST API have a 15 minute timeout, which can affect bulk operations. For example, the following **Update-DistributionGroupMember** command to update 10000 members of a distribution group might time out: +- Cmdlets backed by the REST API have a 15-minute timeout, which can affect bulk operations. For example, the following **Update-DistributionGroupMember** command to update 10,000 members of a distribution group might time out: ```powershell $Members = @("member1","member2",...,"member10000") @@ -134,25 +129,22 @@ Consider the following items for connections in remote PowerShell mode: } ``` -For additional information about what's new in the EXO V3 module, see the [Release notes](#release-notes) section later in this article. +For more information about what's new in the EXO V3 module, see the [Release notes](#release-notes) section later in this article. -## Report bugs and issues for the Exchange Online PowerShell module +## Report bugs and issues for Preview versions of the Exchange Online PowerShell module -> [!NOTE] -> For General Availability (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. +> [!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. -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: +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 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| |---|---| @@ -166,7 +158,7 @@ All versions of the module contain nine exclusive **Get-EXO\*** cmdlets for Exch |[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)| -> [!NOTE] +> [!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: @@ -178,6 +170,9 @@ The connection-related cmdlets in the module are listed in the following table: |[Disconnect-ExchangeOnline](/powershell/module/exchange/disconnect-exchangeonline)|[Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession)|| |[Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation)|[Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)|Available in v3.0.0 or later.| +> [!TIP] +> Frequent use of the **Connect-ExchangeOnline** and **Disconnect-ExchangeOnline** cmdlets in a single PowerShell session or script might lead to a memory leak. The best way to avoid this issue is to use the _CommandName_ parameter on the **Connect-ExchangeOnline** cmdlet to limit the cmdlets that are used in the session. + Miscellaneous Exchange Online cmdlets that happen to be in the module are listed in the following table: |Cmdlet|Comments| @@ -198,6 +193,9 @@ Miscellaneous Exchange Online cmdlets that happen to be in the module are listed |[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 @@ -221,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: @@ -245,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). @@ -276,7 +272,7 @@ 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.2 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.2, see [this article](/dotnet/framework/migration-guide/versions-and-dependencies#net-framework-472). +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: @@ -286,7 +282,7 @@ Windows PowerShell requirements and module support **in older versions of Window - Windows Server 2008 R2 SP1² ³ ⁴ - ¹ PowerShell 7 on this version of Windows requires the [Windows 10 Universal C Runtime (CRT)](https://www.microsoft.com/download/details.aspx?id=50410). -- ² This version of Windows has reached its end of support, and is now supported only in Azure virtual machines. +- ² 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). @@ -294,10 +290,10 @@ Windows PowerShell requirements and module support **in older versions of Window #### Set the PowerShell execution policy to RemoteSigned -> [!NOTE] +> [!TIP] > The settings in this section apply to all versions of PowerShell on all operating systems. -PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: +PowerShell needs to be configured to run scripts, and by default, it isn't. You get the following error when you try to connect: > Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. @@ -311,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](#rest-api-connections-in-the-exo-v3-module), the information in this section applies to remote PowerShell connections only. Remote PowerShell connections to Exchange Online PowerShell and Security & Compliance PowerShell will be retired. 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). REST-based connections don't require Basic authentication in WinRM as described in this section. +> [!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 only (not REST API connections), 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. +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**: @@ -345,20 +341,20 @@ If you don't see the value `Basic = true`, you need to run **one** of the follow 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-based connections in Windows +### PowerShellGet for REST API connections in Windows -[REST-based 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 version 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). +[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). -> [!NOTE] +> [!TIP] > 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-based connection, you'll get the following error when you try to connect: +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 @@ -370,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): @@ -436,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): @@ -510,6 +506,16 @@ For detailed syntax and parameter information, see [Update-Module](/powershell/m 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: @@ -540,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 isn't 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: @@ -573,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: @@ -591,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 contains far fewer properties, and the time it takes to return those results is 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. @@ -617,13 +613,49 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo ### Current release -#### Version 3.4.0 +#### Version 3.7.2 -- 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). +- The _DisableWAM_ switch is available on the **Connect-ExchangeOnline** cmdlet to disable Web Account Manager (WAM) if you get WAM-related connection errors. ### Previous releases +#### Version 3.7.1 + +- Added a new property named `ExoExchangeSecurityDescriptor` to the output of **Get-EXOMailbox** that's similar to the `ExchangeSecurityDescriptor` property in the output of **Get-Mailbox**. +- Added new cmdlets to support the Viva Org Insights Delegation feature: + - **Add-VivaOrgInsightsDelegatedRole** + - **Get-VivaOrgInsightsDelegatedRole** + - **Remove-VivaOrgInsightsDelegatedRole** + +#### Version 3.7.0 + +- Integrated Web Account Manager (WAM) in authentication flows to enhance security. +- Command line help for Exchange Online PowerShell cmdlets is no longer loaded by default. Use the _LoadCmdletHelp_ switch in the **Connect-ExchangeOnline** command so help for Exchange Online PowerShell cmdlets is available to the **Get-Help** cmdlet. +- Fixed connection issues with app only authentication in Security & Compliance PowerShell. + +#### Version 3.6.0 + +- **Get-VivaModuleFeature** now returns information about the kinds of identities that the feature supports creating policies for (for example, users, groups, or the entire tenant). +- Cmdlets for Viva feature access management now handle continuous access evaluation (CAE) claim challenges. +- Added fix for compatibility issue with the Microsoft.Graph module. + +#### 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. @@ -637,7 +669,7 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo - **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 Center PowerShell. +- 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. @@ -658,7 +690,7 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo - The _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet for REST-based connections (version 2.0.6-Preview8 or later). - The _DelegatedOrganization_ parameter works in the **Connect-IPPSSession** cmdlet as long as you also use the _AzureADAuthorizationEndpointUri_ parameter in the command. - Certain cmdlets that used to prompt for confirmation in specific scenarios no longer do so. By default, the cmdlet runs to completion. -- The format of the error returned from failed cmdlet execution has been slightly modified. The exception now contains additional data (for example, the exception type), and the `FullyQualifiedErrorId` doesn't contain the `FailureCategory`. The format of the error is subject to further modification. +- 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 @@ -675,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. @@ -697,7 +729,7 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo #### 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. @@ -710,25 +742,25 @@ 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. + - 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. 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 +- 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 @@ -738,17 +770,17 @@ Unless otherwise noted, the current release of the Exchange Online PowerShell mo #### 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 4f642cdab6..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: 9/1/2023 +manager: deniseb +ms.date: 05/07/2025 ms.audience: Admin audience: Admin ms.topic: article diff --git a/exchange/docs-conceptual/exchange-online-protection-powershell.md b/exchange/docs-conceptual/exchange-online-protection-powershell.md index 2d3084394e..93e9dd4bf7 100644 --- a/exchange/docs-conceptual/exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/exchange-online-protection-powershell.md @@ -2,7 +2,7 @@ title: "Exchange Online Protection PowerShell" ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 9/1/2023 ms.audience: Admin audience: Admin diff --git a/exchange/docs-conceptual/filter-properties.md b/exchange/docs-conceptual/filter-properties.md index e3cdc34fd7..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: 8/8/2023 +manager: deniseb +ms.date: 1/9/2024 ms.audience: ITPro audience: ITPro ms.topic: article @@ -105,7 +105,7 @@ After you have the device ID value, you can use it in a filter. For example, `Ge |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'`. @@ -126,7 +126,7 @@ You can find the distinguished names of ActiveSync mailbox policies by running t |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'`. @@ -260,7 +260,7 @@ For example, `Get-Recipient -Filter 'ArchiveRelease -ne $null'`. |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'"`. @@ -354,7 +354,7 @@ For example, `Get-Mailbox -Filter 'CalendarRepairDisabled -eq $true'`. |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). @@ -380,7 +380,7 @@ For example, `Get-User -Filter "Company -like 'Contoso*'"`. |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'`. @@ -388,7 +388,7 @@ For example, `Get-Mailbox -Filter 'ComplianceTagHoldApplied -eq $true'`. |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'`. @@ -520,7 +520,7 @@ You can find the distinguished names of recipients by running this command: `Get |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'`. @@ -540,7 +540,7 @@ Although this property is multi-valued, the filter returns a match if the proper |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'`. @@ -714,7 +714,7 @@ Although this property is multi-valued, the filter returns a match if the proper |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"`. @@ -722,7 +722,7 @@ For example, `Get-UnifiedGroup -Filter "GroupMemberCount -gt 100"`. |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"`. @@ -752,7 +752,7 @@ Note that an object's GUID value is different than its Exchange GUID value. |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'`. @@ -794,7 +794,7 @@ To find the distinguished name of a recipient, replace _\_ w |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'`. @@ -802,7 +802,7 @@ For example, `Get-MailPublicFolder -Filter 'IgnoreMissingFolderLink -eq $true'`. |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'`. @@ -818,7 +818,7 @@ For example, `Get-Mailbox -Filter 'ImmutableId -ne $null'`. |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'`. @@ -846,7 +846,7 @@ Although this property is multi-valued, the filter returns a match if the proper |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'"`. @@ -866,7 +866,7 @@ For example, `Get-User -Filter 'IsDirSynced -eq $true'`. |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'`. @@ -874,7 +874,7 @@ For example, `Get-Mailbox -Filter 'IsExcludedFromServingHierarchy -eq $true'`. |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'`. @@ -882,7 +882,7 @@ For example, `Get-Mailbox -Filter 'IsHierarchyReady -eq $false'`. |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'`. @@ -890,7 +890,7 @@ For example, `Get-Mailbox -Filter 'IsHierarchySyncEnabled -eq $false'`. |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'`. @@ -898,7 +898,7 @@ For example, `Get-Mailbox -Filter 'IsInactiveMailbox -eq $false'`. |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'`. @@ -906,7 +906,7 @@ For example, `Get-Mailbox -Filter 'IsLinked -eq $true'`. |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'`. @@ -914,7 +914,7 @@ For example, `Get-Mailbox -Filter 'IsMailboxEnabled -eq $false'`. |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'`. @@ -922,7 +922,7 @@ For example, `Get-Mailbox -Filter 'IsResource -eq $true'`. |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'`. @@ -930,7 +930,7 @@ For example, `Get-User -Filter 'IsSecurityPrincipal -eq $false'`. |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'`. @@ -938,7 +938,7 @@ For example, `Get-Mailbox -Filter 'IsShared -eq $true'`. |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'`. @@ -946,7 +946,7 @@ For example, `Get-Mailbox -Filter 'IsSoftDeletedByDisable -eq $true'`. |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'`. @@ -964,7 +964,7 @@ You can't use the _Filter_ parameter to look for size values of this property. I |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'"`. @@ -1010,7 +1010,7 @@ For example, `Get-Mailbox -Filter "LitigationHoldDate -gt '8/13/2017'"`. |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'`. @@ -1162,7 +1162,7 @@ To find the distinguished name of a manager, replace _\_ wit |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'`. @@ -1292,7 +1292,7 @@ For example, `Get-User -Filter "Name -like 'Laura*'"`. |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`. @@ -1352,7 +1352,7 @@ You can find the distinguished names of offline address books by running this co |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'`. @@ -1392,7 +1392,7 @@ For example, `Get-User -Filter "OtherTelephone -like '206*'"`. |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` @@ -1426,7 +1426,7 @@ For example, `Get-User -Filter "Pager -like '206*'"`. |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)). @@ -1478,7 +1478,7 @@ For example, `Get-Recipient -Filter 'PoliciesIncluded -eq $null'`. |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'`. @@ -1512,7 +1512,7 @@ For example, `Get-User -Filter 'PreviousRecipientTypeDetails -ne $null'`. |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'"`. @@ -1592,7 +1592,7 @@ For example, `Get-Mailbox -Filter "RecipientLimits -ne 'Unlimited'"`. |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'"`. @@ -1600,7 +1600,7 @@ For example, `Get-Recipient -Filter "RecipientType -eq 'MailContact'"`. |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). @@ -1662,7 +1662,7 @@ This filter requires the distinguished name of the remote account policy. For ex |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'`. @@ -1702,7 +1702,7 @@ This property is displayed as **RequireSenderAuthenticationEnabled** in the resu |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'"` @@ -1718,7 +1718,7 @@ For example, `Get-Mailbox -Filter "ResourceCapacity -gt 15"` |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`. @@ -1728,7 +1728,7 @@ When you search for values, use the custom resource property that's assigned to |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'"` @@ -1736,7 +1736,7 @@ For example, `Get-UnifiedGroup -Filter "ResourceProvisioningOptions -eq 'Team'"` |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'"` @@ -1760,7 +1760,7 @@ For example, `Get-Mailbox -Filter "RetentionComment -like '7 years*'"` |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'"`. @@ -1870,7 +1870,7 @@ This is an example of a complete **ServerLegacyDN** value: `/o=Contoso Corporati |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'"`. @@ -1915,7 +1915,7 @@ For example, `Get-User -Filter "SimpleDisplayName -like 'lila*'"`. |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'`. @@ -1923,7 +1923,7 @@ For example, `Get-Mailbox -Filter 'SingleItemRecoveryEnabled -eq $true'`. |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'`. @@ -1931,7 +1931,7 @@ For example, `Get-User -Filter 'SKUAssigned -eq $true'`. |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'`. @@ -2017,7 +2017,7 @@ Although this property is multi-valued, the filter returns a match if the proper |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'`. @@ -2045,7 +2045,7 @@ To find the distinguished names of UM dial plans, run this command: `Get-UMDialP |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'"`. @@ -2053,7 +2053,7 @@ For example, `Get-User -Filter "UpgradeRequest -ne 'None'"`. |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'"`. @@ -2123,7 +2123,7 @@ For example, `Get-Recipient -Filter "WhenChanged -gt '8/1/2017 2:00:00 PM'"`. |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'"`. @@ -2139,7 +2139,7 @@ For example, `Get-Recipient -Filter "WhenCreated -gt '8/1/2017 2:00:00 PM'"`. |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'"`. diff --git a/exchange/docs-conceptual/filters-v2.md b/exchange/docs-conceptual/filters-v2.md index 181ad735f7..aae21efdc2 100644 --- a/exchange/docs-conceptual/filters-v2.md +++ b/exchange/docs-conceptual/filters-v2.md @@ -2,7 +2,7 @@ title: Filters in the Exchange Online PowerShell module ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 9/1/2023 ms.audience: Admin audience: Admin diff --git a/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md index c99a1453e2..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: 9/7/2023 +manager: deniseb +ms.date: 06/06/2024 ms.audience: ITPro audience: ITPro ms.topic: article @@ -17,22 +17,35 @@ 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 in Exchange Online, which are assigned only to the **View-Only Organization Management** and **Organization Management** role groups by default. - - In cloud-based organizations, membership in the **Global Administrators** role in Microsoft Entra ID gives you the required permissions. - - 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](/microsoft-365/security/office-365-security/mdo-portal-permissions) - - [Permissions in the Microsoft Purview compliance portal](/microsoft-365/compliance/microsoft-365-compliance-center-permissions) - -> [!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). + - [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 @@ -47,8 +60,8 @@ You can use PowerShell to find the permissions required to run any Exchange or E $Perms = Get-ManagementRole -Cmdlet [-CmdletParameters ,,...] ``` - > [!TIP] - > If you specify multiple parameters, only roles that include _all_ of the specified parameters on the cmdlet 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: @@ -84,7 +97,7 @@ 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 ,,...] ``` > [!TIP] @@ -140,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 diff --git a/exchange/docs-conceptual/index.yml b/exchange/docs-conceptual/index.yml index da2653482a..7fe140c922 100644 --- a/exchange/docs-conceptual/index.yml +++ b/exchange/docs-conceptual/index.yml @@ -8,10 +8,9 @@ metadata: 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: 9/1/2023 #Required; mm/dd/yyyy format. diff --git a/exchange/docs-conceptual/invoke-command-workarounds-rest-api.md b/exchange/docs-conceptual/invoke-command-workarounds-rest-api.md index 0a6b23d861..50aba1763d 100644 --- a/exchange/docs-conceptual/invoke-command-workarounds-rest-api.md +++ b/exchange/docs-conceptual/invoke-command-workarounds-rest-api.md @@ -1,15 +1,15 @@ --- -title: Workarounds for Invoke-Command scenarios in REST API connections +title: Workarounds for Invoke-Command scenarios in REST API connections ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 7/5/2023 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-powershell ms.reviewer: -ms.localizationpriority: normal +ms.localizationpriority: medium ms.collection: Strat_EX_Admin ms.custom: ms.assetid: @@ -69,15 +69,15 @@ This example finds all mailboxes where the GrantSendOnBehalfTo permission is set - **In a REST API session**: Run the following command: ```powershell - $mailboxes = Get-Mailbox -Filter "GrantSendOnBehalfTo -ne `$null" + $mailboxes = Get-Mailbox -Filter "GrantSendOnBehalfTo -ne `$null" - foreach ($mailbox in $mailboxes) + foreach ($mailbox in $mailboxes) - { - $users = $mailbox | Select-Object GrantSendOnBehalfTo -ExpandProperty GrantSendOnBehalfTo | Get-User + { + $users = $mailbox | Select-Object GrantSendOnBehalfTo -ExpandProperty GrantSendOnBehalfTo | Get-User - $users | Select-Object Name, Guid - } + $users | Select-Object Name, Guid + } ``` ## Scenario 3: Run Exchange Online cmdlets in a specific PowerShell session when multiple sessions are present @@ -113,7 +113,7 @@ This example shows how to create two PowerShell sessions in the same window and 5. Now you can run commands in either session. For example: ```powershell - $CommandStr1 = "Get-$($ConnectionInfo1.ModulePrefix)Mailbox -ResultSize 10" + $CommandStr1 = "Get-$($ConnectionInfo1.ModulePrefix)Mailbox -ResultSize 10" Invoke-Expression $CommandStr1 ``` @@ -121,7 +121,7 @@ This example shows how to create two PowerShell sessions in the same window and Or ```powershell - $CommandStr2 = "Get-$($ConnectionInfo2.ModulePrefix)Mailbox -ResultSize 10" + $CommandStr2 = "Get-$($ConnectionInfo2.ModulePrefix)Mailbox -ResultSize 10" - Invoke-Expression $CommandStr2 + 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-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-select-api-permissions.png deleted file mode 100644 index fc84cc1d6b..0000000000 Binary files a/exchange/docs-conceptual/media/exo-app-only-auth-select-api-permissions.png and /dev/null 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-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 2f41c54e4d..c097a3fc37 100644 --- a/exchange/docs-conceptual/open-the-exchange-management-shell.md +++ b/exchange/docs-conceptual/open-the-exchange-management-shell.md @@ -2,7 +2,7 @@ title: "Open the Exchange Management Shell" ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 9/7/2023 ms.audience: ITPro audience: ITPro diff --git a/exchange/docs-conceptual/recipient-filters.md b/exchange/docs-conceptual/recipient-filters.md index 9fdfa7c24e..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: 9/7/2023 +manager: deniseb +ms.date: 09/07/2023 ms.audience: ITPro audience: ITPro ms.topic: reference @@ -190,15 +190,12 @@ When creating your own custom OPATH filters, consider the following items: - 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"}`). diff --git a/exchange/docs-conceptual/recipientfilter-properties.md b/exchange/docs-conceptual/recipientfilter-properties.md index afdd7cc36e..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 @@ -120,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).|| diff --git a/exchange/docs-conceptual/scc-powershell.md b/exchange/docs-conceptual/scc-powershell.md index 5367b17359..e5ec203673 100644 --- a/exchange/docs-conceptual/scc-powershell.md +++ b/exchange/docs-conceptual/scc-powershell.md @@ -2,7 +2,7 @@ title: "Security & Compliance PowerShell" ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 9/1/2023 ms.audience: Admin audience: Admin @@ -37,6 +37,6 @@ Security & Compliance PowerShell contains the following types of cmdlets: - 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](/microsoft-365/security/office-365-security/anti-spam-protection)) are available only in [Exchange Online PowerShell](exchange-online-powershell.md). + Cmdlets for most EOP and Defender for Office 365 security features (for example, [anti-spam policies](/defender-office-365/anti-spam-protection-about)) are available only in [Exchange Online PowerShell](exchange-online-powershell.md). Check the **Applies to** value in the cmdlet references article to verify the PowerShell environment where the cmdlet actually resides. diff --git a/exchange/docs-conceptual/toc.yml b/exchange/docs-conceptual/toc.yml index dfa8b1ddc8..b19c66c699 100644 --- a/exchange/docs-conceptual/toc.yml +++ b/exchange/docs-conceptual/toc.yml @@ -68,6 +68,8 @@ 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: Exchange Online Protection PowerShell diff --git a/exchange/docs-conceptual/values-for-custompropertynames-parameter.md b/exchange/docs-conceptual/values-for-custompropertynames-parameter.md index 6d91a06c9f..ea729cff90 100644 --- a/exchange/docs-conceptual/values-for-custompropertynames-parameter.md +++ b/exchange/docs-conceptual/values-for-custompropertynames-parameter.md @@ -2,7 +2,7 @@ title: Values for the CustomPropertyNames parameter ms.author: chrisda author: chrisda -manager: dansimp +manager: deniseb ms.date: 9/7/2023 ms.audience: Admin audience: Admin 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 1f92bcedb6..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: 11/7/2023 +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,44 @@ 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) @@ -53,7 +91,7 @@ This article lists new features in the Exchange Online PowerShell module that's > [!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-based-connections-in-windows). + > 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 @@ -81,7 +119,7 @@ This article lists new features in the Exchange Online PowerShell module that's - 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-based-connections-in-windows). + > 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. diff --git a/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md index c063d4536c..aedd7aee1a 100644 --- a/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md +++ b/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md @@ -45,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 @@ -71,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 @@ -89,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 @@ -162,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). @@ -180,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 @@ -198,7 +205,11 @@ Accept wildcard characters: False ### -TargetServiceEpr This parameter is available only in the cloud-based service. -{{ Fill TargetServiceEpr Description }} +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 @@ -216,7 +227,7 @@ Accept wildcard characters: False ### -TargetTenantId This parameter is available only in the cloud-based service. -{{ Fill TargetTenantId Description }} +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 diff --git a/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md b/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md index f5acf3ead8..d987ed4c56 100644 --- a/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md +++ b/exchange/exchange-ps/exchange/Add-IPAllowListEntry.md @@ -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 b6f106b3b0..35072b31fd 100644 --- a/exchange/exchange-ps/exchange/Add-IPBlockListEntry.md +++ b/exchange/exchange-ps/exchange/Add-IPBlockListEntry.md @@ -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 57d7b1122d..bda1bfce49 100644 --- a/exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Add-MailboxFolderPermission.md @@ -146,7 +146,7 @@ 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: diff --git a/exchange/exchange-ps/exchange/Add-MailboxPermission.md b/exchange/exchange-ps/exchange/Add-MailboxPermission.md index 47a39e1221..07ab0e946e 100644 --- a/exchange/exchange-ps/exchange/Add-MailboxPermission.md +++ b/exchange/exchange-ps/exchange/Add-MailboxPermission.md @@ -420,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-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-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md index 1004d761bf..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,7 +46,7 @@ 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 @@ -80,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: @@ -93,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[] @@ -113,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 index c848617630..340921a576 100644 --- a/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Add-VivaModuleFeaturePolicy.md @@ -15,27 +15,26 @@ ms.reviewer: ## 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). -**Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. - -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. Note that: +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. +- 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. +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] - [-GroupIds ] - [-UserIds ] [-Everyone] + [-GroupIds ] [-IsUserControlEnabled ] + [-IsUserOptedInByDefault ] [-ResultSize ] + [-UserIds ] [-WhatIf] [] ``` @@ -47,9 +46,14 @@ 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. +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). -To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/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 @@ -62,7 +66,7 @@ This example adds a policy for the Reflection feature in Viva Insights. The poli ### Example 2 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleGroups -IsFeatureEnabled $false -GroupIds group1@contoso.com,group2@contoso.com +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. @@ -76,11 +80,18 @@ This example adds a policy for the Reflection feature in Viva Insights. The poli ### Example 4 ```powershell -Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name UsersAndGroups -IsFeatureEnabled $false -GroupIds group1@contoso.com,group2@contoso.com -UserIds user1@contoso.com,user2@contoso.com +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 @@ -194,12 +205,14 @@ Accept wildcard characters: False ``` ### -GroupIds -The GroupIds parameter specifies the SMTP addresses (email addresses) of the groups that the policy applies to. [Mail-enabled Microsoft Entra groups]( https://learn.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. +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) @@ -214,9 +227,9 @@ Accept wildcard characters: False ``` ### -IsUserControlEnabled -**Note**: This parameter is available in version 3.3.0 or later of the module. +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: +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. @@ -236,6 +249,31 @@ 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. @@ -303,4 +341,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) -[Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids) +[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 1e065c2670..ddb6eb30ff 100644 --- a/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md @@ -28,9 +28,9 @@ 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/purview/microsoft-365-compliance-center-permissions). diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index 29a0d02321..96f0891ba3 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -42,8 +42,10 @@ Connect-ExchangeOnline [-CertificateThumbprint ] [-Credential ] [-Device] + [-DisableWAM] [-EnableErrorReporting] [-InlineCredential] + [-LoadCmdletHelp] [-LogDirectoryPath ] [-LogLevel ] [-ManagedIdentity] @@ -201,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 @@ -275,9 +277,9 @@ Accept wildcard characters: False ### -AccessToken **Note**: This parameter is available in version 3.1.0 or later of the module. -The AccessToken parameter specifies the OAuth JSON Web Token (JWT) that's used to connect to 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 @@ -458,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. @@ -496,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`. @@ -580,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). @@ -678,9 +722,11 @@ Accept wildcard characters: False ### -SkipLoadingCmdletHelp **Note**: This parameter is available in version 3.3.0 or later of the module. -The SkipLoadingCmdletHelp switch avoids downloading the cmdlet help files for REST API connections. You don't need to specify a value with this switch. +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. +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. @@ -698,7 +744,7 @@ Accept wildcard characters: False ``` ### -SkipLoadingFormatData -The SkipLoadingFormatData switch avoids downloading the format data for REST API connections. You don't need to specify a value with this switch. +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. @@ -760,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). @@ -778,7 +824,7 @@ Accept wildcard characters: False ``` ### -UseRPSSession -**Note**: Remote PowerShell connections to Exchange Online PowerShell are deprecated. For more information, see [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). +**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. diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md index 029160bcd3..a260cad194 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -32,6 +32,7 @@ Connect-IPPSSession [[-Prefix] ] [[-CommandName] ] [[-FormatTypeName] ] + [-AccessToken ] [-AppId ] [-BypassMailboxAnchoring] [-Certificate ] @@ -218,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`. @@ -399,7 +420,7 @@ 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). +**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. diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md index aa18b3839a..3dc21e421f 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -151,6 +151,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md index faee2465e5..fe87141f2e 100644 --- a/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md @@ -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). 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 e23c8c51c6..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). 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-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md index 10321ce0a5..35ef4b854d 100644 --- a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md @@ -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). 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/Disconnect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md index 0bc4fb6340..c2a6bb1153 100644 --- a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md @@ -114,6 +114,7 @@ Don't use this parameter with the ModulePrefix parameter. Type: String[] Parameter Sets: ConnectionId Aliases: +Applicable: Exchange Online Required: True Position: Named @@ -133,6 +134,7 @@ Don't use this parameter with the ConnectionId parameter. Type: String[] Parameter Sets: ModulePrefix Aliases: +Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md index 93020ccce4..af887e025f 100644 --- a/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md @@ -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). 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-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md index 7ff9b62271..2642212149 100644 --- a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md @@ -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). 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/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 4a881b8b7c..8d5bf12471 100644 --- a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md +++ b/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md @@ -33,6 +33,135 @@ Export-ActivityExplorerData -EndTime -OutputFormat -StartTim ``` ## DESCRIPTION +This cmdlet supports following filters: + +- Activity +- Application +- ArtifactType +- ClientIP +- ColdScanPolicyId +- CopilotAppHost +- CopilotThreadId +- CopilotType +- CreationTime +- DataState +- DestinationFilePath +- DestinationLocationType +- DeviceName +- DLPPolicyId +- DLPPolicyRuleId +- EmailReceiver +- EmailSender +- EndpointOperation +- EnforcementMode +- FalsePositive +- FileExtension +- GeneralPurposeComparison +- HowApplied +- HowAppliedDetail +- IrmUrlCategory +- IsProtected +- IsProtectedBefore +- ItemName +- LabelEventType +- Location +- MDATPDeviceId +- OriginatingDomain +- PageSize +- ParentArchiveHash +- Platform +- PolicyId +- PolicyMode +- PolicyName +- PolicyRuleAction +- PolicyRuleId +- PolicyRuleName +- PreviousFileName +- PreviousProtectionOwner +- ProtectionEventType +- ProtectionOwner +- RemovableMediaDeviceManufacturer +- RemovableMediaDeviceModel +- RemovableMediaDeviceSerialNumber +- RetentionLabel +- RMSEncrypted +- SensitiveInfoTypeClassifierType +- SensitiveInfoTypeConfidence +- SensitiveInfoTypeCount +- SensitiveInfoTypeId +- SensitivityLabel +- SensitivityLabelPolicy +- Sha1 +- Sha256 +- SourceLocationType +- TargetDomain +- TargetPrinterName +- User +- UsersPerDay +- Workload + +Valid workload filters include the following values: + +- Copilot +- Endpoint +- Exchange +- OnPremisesFileShareScanner +- OnPremisesSharePointScanner +- OneDrive +- PowerBI +- PurviewDataMap +- SharePoint + +Valid activity filters include the following values: + +- AIAppInteraction +- ArchiveCreated +- AutoLabelingSimulation +- BrowseToUrl +- ChangeProtection +- ClassificationAdded +- ClassificationDeleted +- ClassificationUpdated +- CopilotInteraction +- DLPInfo +- DLPRuleEnforce +- DLPRuleMatch +- DLPRuleUndo +- DlpClassification +- DownloadFile +- DownloadText +- FileAccessedByUnallowedApp +- FileArchived +- FileCopiedToClipboard +- FileCopiedToNetworkShare +- FileCopiedToRemoteDesktopSession +- FileCopiedToRemovableMedia +- FileCreated +- FileCreatedOnNetworkShare +- FileCreatedOnRemovableMedia +- FileDeleted +- FileDiscovered +- FileModified +- FilePrinted +- FileRead +- FileRenamed +- FileTransferredByBluetooth +- FileUploadedToCloud +- LabelApplied +- LabelChanged +- LabelRecommended +- LabelRecommendedAndDismissed +- LabelRemoved +- NewProtection +- PastedToBrowser +- RemoveProtection +- ScreenCapture +- UploadFile +- UploadText +- WebpageCopiedToClipboard +- WebpagePrinted +- WebpageSavedToLocal + To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -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,14 +214,14 @@ 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 @@ -122,7 +259,7 @@ 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 @@ -232,7 +369,7 @@ 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 @@ -248,7 +385,7 @@ Accept wildcard characters: False ``` ### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 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 @@ -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-ContentExplorerData.md b/exchange/exchange-ps/exchange/Export-ContentExplorerData.md index 40c794e154..85f8802e21 100644 --- a/exchange/exchange-ps/exchange/Export-ContentExplorerData.md +++ b/exchange/exchange-ps/exchange/Export-ContentExplorerData.md @@ -12,6 +12,8 @@ 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. @@ -21,13 +23,12 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Export-ContentExplorerData +Export-ContentExplorerData [-TagName] [-TagType] + [-Aggregate] [[-PageCookie] ] [[-PageSize] ] [[-SiteUrl] ] [[-UserPrincipalName] ] - [-TagName] - [-TagType] [[-Workload] ] [] ``` @@ -40,6 +41,14 @@ The output of this cmdlet contains the following information: - 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 @@ -67,6 +76,53 @@ This example exports records for the specified sensitive info type for all workl ## 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. @@ -86,6 +142,8 @@ 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) @@ -133,27 +191,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -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 -``` - ### -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. 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-QuarantineMessage.md b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md index 6a508389b8..f20bb9e7c2 100644 --- a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md @@ -29,6 +29,7 @@ Export-QuarantineMessage -Identities [-Identity ] [-ForceConversionToMime] [-Password ] + [-PasswordV2 ] [-ReasonForExport ] [-RecipientAddress ] [] @@ -41,6 +42,7 @@ Export-QuarantineMessage -Identity [-EntityType ] [-ForceConversionToMime] [-Password ] + [-PasswordV2 ] [-ReasonForExport ] [-RecipientAddress ] [] @@ -160,6 +162,7 @@ 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 @@ -201,6 +204,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 enter the password in plain text, use the PasswordV2 parameter. + ```yaml Type: SecureString Parameter Sets: (All) @@ -214,6 +219,22 @@ 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 ("). diff --git a/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md index a8b1f99434..714d4981eb 100644 --- a/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md @@ -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). @@ -75,7 +75,7 @@ Type: RuleState Parameter Sets: (All) Aliases: Accepted values: Enabled, Disabled -Applicable: Exchange Onlinen +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 543ed848a6..f0a24d140f 100644 --- a/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md @@ -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). diff --git a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md b/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md index c2d5aebe9d..754759eea3 100644 --- a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md +++ b/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md @@ -142,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 @@ -208,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-ActivityAlert.md b/exchange/exchange-ps/exchange/Get-ActivityAlert.md deleted file mode 100644 index 21a8eb6d92..0000000000 --- a/exchange/exchange-ps/exchange/Get-ActivityAlert.md +++ /dev/null @@ -1,80 +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). - -**Note**: Activity alerts have been effectively replaced by alert policies and the corresponding **\*-ProtectionAlert** cmdlets. For more information about alert policies, see [Alert policies in Microsoft 365](https://learn.microsoft.com/purview/alert-policies). - -Use the Get-ActivityAlert cmdlet to view activity alerts. Activity alerts send 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 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/purview/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-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-AggregateZapReport.md b/exchange/exchange-ps/exchange/Get-AggregateZapReport.md index d3bb413b02..fd62052590 100644 --- a/exchange/exchange-ps/exchange/Get-AggregateZapReport.md +++ b/exchange/exchange-ps/exchange/Get-AggregateZapReport.md @@ -59,7 +59,7 @@ This example retrieves information for the specified date range. ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". If you use the EndDate parameter, you also need to use the StartDate parameter. @@ -111,7 +111,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". If you use this parameter, you also need to use the StartDate parameter. 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-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md index 8e787b61b6..31818f3779 100644 --- a/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md +++ b/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md @@ -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-security/safe-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). diff --git a/exchange/exchange-ps/exchange/Get-AuditConfigurationPolicy.md b/exchange/exchange-ps/exchange/Get-AuditConfigurationPolicy.md deleted file mode 100644 index ad6f407e7f..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/purview/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 ae24ebbabd..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/purview/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 409008139b..47aaff24d4 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md @@ -66,8 +66,6 @@ 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. -**Note**: You can ignore errors about distribution in policy for SharePoint and OneDrive workloads. - ```yaml Type: SwitchParameter Parameter Sets: (All) 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-CalendarDiagnosticLog.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md index a1456c87dc..38b63df96c 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md @@ -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 f23f83577b..e01ded63d5 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md @@ -188,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 @@ -429,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-ClientAccessRule.md b/exchange/exchange-ps/exchange/Get-ClientAccessRule.md index 17b0b978dd..0e40aa0d98 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Get-ClientAccessRule.md @@ -13,7 +13,7 @@ ms.reviewer: ## SYNOPSIS > [!NOTE] -> Beginning in October 2022, we've disabled access to client access rules for all existing Exchange Online organizations that weren't using them. In September 2024, support for client access rules will end for all Exchange Online organizations. For more information, see [Update: Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/update-deprecation-of-client-access-rules-in-exchange-online/ba-p/3790165). +> 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. diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md b/exchange/exchange-ps/exchange/Get-ComplianceSearch.md index 920d29651e..95ca1983f2 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSearch.md @@ -93,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 cd108c7a4f..a0ca0a62b5 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md @@ -177,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. @@ -211,7 +213,7 @@ Accept wildcard characters: False ``` ### -Organization -This parameter is available only in the cloud-based organization. +This parameter is available only in the cloud-based service. This parameter is reserved for internal Microsoft use. diff --git a/exchange/exchange-ps/exchange/Get-ComplianceTag.md b/exchange/exchange-ps/exchange/Get-ComplianceTag.md index 982e576f4b..2c704b8488 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceTag.md @@ -23,6 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-ComplianceTag [[-Identity] ] [-IncludingLabelState] + [-PriorityCleanup] [] ``` @@ -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 38b6bdefba..c3aa8eaca3 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-ComplianceTagStorage [[-Identity] ] + [-Organization ] [] ``` @@ -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 84e5de8235..d26e9e5e0d 100644 --- a/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md +++ b/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md @@ -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 ef41e95e63..07d5d63148 100644 --- a/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md @@ -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 d653eaddab..ff118bc38d 100644 --- a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md +++ b/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md @@ -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 0aab4abcc3..97f9d3efd2 100644 --- a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md +++ b/exchange/exchange-ps/exchange/Get-ConnectionInformation.md @@ -45,16 +45,16 @@ The output of the cmdlet contains the following properties: - 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, for Exchange Online PowerShell or for Security & Compliance PowerShell. -- AzureAdAuthorizationEndpointUri : The Microsoft Entra authorization endpoint for the connection. For example, for Exchange Online PowerShell or 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 the Organization parameter in the Connect-ExchangeOnline or Connect-IPPSSession command for CBA or managed identity connections. -- DelegatedOrganization: The value specified using the the DelegatedOrganization parameter in the Connect-ExchangeOnline or Connect-IPPSSession command. -- AppId: The value specified using the the AppId parameter in the Connect-ExchangeOnline or Connect-IPPSSession command for CBA connections. +- 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. @@ -97,6 +97,7 @@ Don't use this parameter with the ModulePrefix parameter. Type: String[] Parameter Sets: ConnectionId Aliases: +Applicable: Exchange Online Required: True Position: Named @@ -118,6 +119,7 @@ Don't use this parameter with the ConnectionId parameter. Type: String[] Parameter Sets: ModulePrefix Aliases: +Applicable: Exchange Online Required: True Position: Named diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md index 34623d7b0d..2c884d0e2f 100644 --- a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md +++ b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md @@ -79,7 +79,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/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 @@ -129,7 +129,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md index 0053ce7fd8..eb99b53c05 100644 --- a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md @@ -81,7 +81,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/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 @@ -131,7 +131,7 @@ 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 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-CsPSTNUsageDetailReport.md b/exchange/exchange-ps/exchange/Get-CsPSTNUsageDetailReport.md deleted file mode 100644 index 56e4f52e18..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsPSTNUsageDetailReport.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-cspstnusagedetailreport -applicable: Exchange Online -title: Get-CsPSTNUsageDetailReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-CsPSTNUsageDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://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. - -For 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 ] - [] -``` - -## DESCRIPTION -You can use the Get-CsPSTNUsageDetailReport to query information about PSTN usage details in Skype for Business Online for the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- SipUri -- DateTimeOfCall -- TelephoneNumber -- CallID -- CallType -- Location -- CallDuration -- Currency -- CallCharge - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-CsPSTNUsageDetailReport -StartDate 11/01/2015 -EndDate 12/30/2015 -``` - -This example shows the PSTN usage detail for users in November and December. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CsUserActivitiesReport.md b/exchange/exchange-ps/exchange/Get-CsUserActivitiesReport.md deleted file mode 100644 index 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 77538000c9..1f38d8c687 100644 --- a/exchange/exchange-ps/exchange/Get-DataRetentionReport.md +++ b/exchange/exchange-ps/exchange/Get-DataRetentionReport.md @@ -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 index da09930b92..13ed2a7226 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md @@ -38,7 +38,10 @@ To run this cmdlet, you need to be a member of one of the following directory ro - Exchange Administrator - Insights Administrator -For more information, see [Microsoft Entra built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). +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 diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md index b66a9eadbe..76bb40fd28 100644 --- a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -34,7 +34,10 @@ To run this cmdlet, you need to be a member of one of the following directory ro - Exchange Administrator - Insights Administrator -For more information, see [Microsoft Entra built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). +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 diff --git a/exchange/exchange-ps/exchange/Get-DetailZapReport.md b/exchange/exchange-ps/exchange/Get-DetailZapReport.md index 3704fd5624..e2332bf377 100644 --- a/exchange/exchange-ps/exchange/Get-DetailZapReport.md +++ b/exchange/exchange-ps/exchange/Get-DetailZapReport.md @@ -70,7 +70,7 @@ This example retrieves information for the specified date range. ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". If you use this parameter, you also need to use the StartDate parameter. @@ -122,7 +122,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". If you use this parameter, you also need to use the StartDate parameter. diff --git a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md index 6f81703a8f..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 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/purview/microsoft-365-compliance-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 a6decc8155..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 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/purview/microsoft-365-compliance-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 4892272f3e..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 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/purview/microsoft-365-compliance-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 813338de6b..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 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/purview/microsoft-365-compliance-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 30e77a7041..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 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/purview/microsoft-365-compliance-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 19f4fed18d..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 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/purview/microsoft-365-compliance-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 949aa60af3..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 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/purview/microsoft-365-compliance-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 9cfc557bfe..601c6b2a36 100644 --- a/exchange/exchange-ps/exchange/Get-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Get-DistributionGroup.md @@ -30,6 +30,9 @@ Get-DistributionGroup [-Anr ] [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] [-OrganizationalUnit ] [-ReadFromDomainController] [-RecipientTypeDetails ] @@ -47,6 +50,9 @@ Get-DistributionGroup [[-Identity] ] [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] [-OrganizationalUnit ] [-ReadFromDomainController] [-RecipientTypeDetails ] @@ -63,6 +69,9 @@ Get-DistributionGroup [-Credential ] [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] [-ManagedBy ] [-OrganizationalUnit ] [-ReadFromDomainController] @@ -231,7 +240,9 @@ Accept wildcard characters: False ### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames This parameter is available only in the cloud-based service. -{{ Fill IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames Description }} +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 @@ -249,7 +260,9 @@ Accept wildcard characters: False ### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames This parameter is available only in the cloud-based service. -{{ Fill IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames Description }} +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 @@ -267,7 +280,69 @@ Accept wildcard characters: False ### -IncludeAcceptMessagesOnlyFromWithDisplayNames This parameter is available only in the cloud-based service. -{{ Fill IncludeAcceptMessagesOnlyFromWithDisplayNames Description }} +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 diff --git a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md index 24e033282d..f5a379ed1b 100644 --- a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md @@ -22,10 +22,12 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-DlpCompliancePolicy [[-Identity] ] + [-DisplayName ] [-DistributionDetail] [-ForceValidate ] [-IncludeExtendedProperties ] [-IncludeRulesMetadata ] + [-IncludeSimulationResults ] [-IRMUserRiskConfiguredAnyRule] [-Summary] [] @@ -62,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 @@ -87,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) @@ -167,6 +187,22 @@ 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 954bc3ec75..3ec06ed550 100644 --- a/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-DlpComplianceRule [[-Identity] ] + [-DisplayName ] [-IncludeExecutionRuleGuids ] [-Policy ] [] @@ -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 6e36c86f70..624222fe8e 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpDetailReport.md @@ -12,9 +12,9 @@ ms.reviewer: # Get-DlpDetailReport ## SYNOPSIS -This cmdlet is available only in the cloud-based service. +**Note**: This cmdlet has been retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. -**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. +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. @@ -152,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 @@ -252,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 24ccbac623..0a9115f073 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md @@ -142,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 @@ -267,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-DlpIncidentDetailReport.md b/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md index f27030082e..c9eaf7d98e 100644 --- a/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md @@ -157,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 @@ -257,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-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-DlpSiDetectionsReport.md b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md index 39d0902d6b..b89d2416f2 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md @@ -61,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-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md index a166b4f4cd..d988b7788e 100644 --- a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md @@ -30,6 +30,9 @@ Get-DynamicDistributionGroup [-Anr ] [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] [-IncludeSystemObjects] [-OrganizationalUnit ] [-ReadFromDomainController] @@ -48,6 +51,9 @@ Get-DynamicDistributionGroup [[-Identity] ] [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] [-IncludeSystemObjects] [-OrganizationalUnit ] [-ReadFromDomainController] @@ -66,6 +72,9 @@ Get-DynamicDistributionGroup [-ManagedBy ] [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] [-IncludeSystemObjects] [-OrganizationalUnit ] [-ReadFromDomainController] @@ -245,7 +254,9 @@ Accept wildcard characters: False ### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames This parameter is available only in the cloud-based service. -{{ Fill IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames Description }} +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 @@ -263,7 +274,9 @@ Accept wildcard characters: False ### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames This parameter is available only in the cloud-based service. -{{ Fill IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames Description }} +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 @@ -281,7 +294,69 @@ Accept wildcard characters: False ### -IncludeAcceptMessagesOnlyFromWithDisplayNames This parameter is available only in the cloud-based service. -{{ Fill IncludeAcceptMessagesOnlyFromWithDisplayNames Description }} +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 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-EXOMailboxFolderStatistics.md b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md index ca0a782625..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 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-EXORecipient.md b/exchange/exchange-ps/exchange/Get-EXORecipient.md index 7052989de4..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). diff --git a/exchange/exchange-ps/exchange/Get-EtrLimits.md b/exchange/exchange-ps/exchange/Get-EtrLimits.md index 792b635c5d..759a8d045c 100644 --- a/exchange/exchange-ps/exchange/Get-EtrLimits.md +++ b/exchange/exchange-ps/exchange/Get-EtrLimits.md @@ -9,7 +9,6 @@ ms.author: chrisda ms.reviewer: --- - # Get-EtrLimits ## SYNOPSIS 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-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 57% rename from exchange/exchange-ps/exchange/Get-SecOpsOverrideRule.md rename to exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md index d1d90e7d85..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, Exchange Online Protection -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, Exchange Online Protection +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, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -86,7 +98,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +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, Exchange Online Protection +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, Exchange Online Protection +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 53% rename from exchange/exchange-ps/exchange/Remove-ActivityAlert.md rename to exchange/exchange-ps/exchange/Get-FeatureConfiguration.md index 91764663e1..87063ff596 100644 --- a/exchange/exchange-ps/exchange/Remove-ActivityAlert.md +++ b/exchange/exchange-ps/exchange/Get-FeatureConfiguration.md @@ -1,51 +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). -**Note**: Activity alerts have been effectively replaced by alert policies and the corresponding **\*-ProtectionAlert** cmdlets. For more information about alert policies, see [Alert policies in Microsoft 365](https://learn.microsoft.com/purview/alert-policies). +> [!NOTE] +> This cmdlet is currently available in Public Preview, isn't available in all organizations, and is subject to change. -Use the Remove-ActivityAlert cmdlet to remove activity alerts. +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 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/purview/microsoft-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) @@ -57,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 @@ -100,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-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-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-InboxRule.md b/exchange/exchange-ps/exchange/Get-InboxRule.md index 86833fd8e3..5ed6b13784 100644 --- a/exchange/exchange-ps/exchange/Get-InboxRule.md +++ b/exchange/exchange-ps/exchange/Get-InboxRule.md @@ -51,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. @@ -98,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 diff --git a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md index f4c144dedf..5b27ac86dc 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md @@ -52,7 +52,7 @@ For the reporting period you specify, the cmdlet returns the following informati - Domain - Subject - Message Size -- Direction: Values are Inbound, Outbound, Or Unknown. Unknown means the messages weren't processed by the filtering stack. In other words, the messages were dropped at the edge before they made it into our filtering stack, so we can't tell the direction for them. +- Direction: Values are Inbound, Outbound, IntraOrg Or Unknown. Unknown means the messages weren't processed by the filtering stack. In other words, the messages were dropped at the edge before they made it into our filtering stack, so we can't tell the direction for them. - Sender Address - Recipient Address - Event Type @@ -134,7 +134,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". ```yaml Type: DateTime @@ -341,7 +341,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". ```yaml Type: DateTime diff --git a/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md b/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md index 9d84ff34ee..370e827191 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md @@ -127,7 +127,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -293,7 +293,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime diff --git a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md b/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md index fa8beeeaf6..218a792389 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md @@ -138,7 +138,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 @@ -271,7 +271,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-MailDetailTransportRuleReport.md b/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md index 7432b4c787..8c7caa8477 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md @@ -110,7 +110,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -275,7 +275,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". Although you can enter a date up to 30 days old, only data from the last 10 days is returned. diff --git a/exchange/exchange-ps/exchange/Get-MailPublicFolder.md b/exchange/exchange-ps/exchange/Get-MailPublicFolder.md index 1361e04533..eea8f2f7e7 100644 --- a/exchange/exchange-ps/exchange/Get-MailPublicFolder.md +++ b/exchange/exchange-ps/exchange/Get-MailPublicFolder.md @@ -27,6 +27,7 @@ Get-MailPublicFolder [-Anr ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-ReadFromDomainController] [-ResultSize ] [-Server ] @@ -40,6 +41,7 @@ Get-MailPublicFolder [[-Identity] ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-ReadFromDomainController] [-ResultSize ] [-Server ] @@ -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 fa4bcf5443..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 ] [] ``` @@ -335,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 5a29162584..8fe274f754 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md @@ -133,7 +133,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 @@ -222,7 +222,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-MailTrafficPolicyReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md index 0a30eeb1a4..f1ab603a7f 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md @@ -165,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 @@ -259,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-MailUser.md b/exchange/exchange-ps/exchange/Get-MailUser.md index b1c28316e1..acaf5fe057 100644 --- a/exchange/exchange-ps/exchange/Get-MailUser.md +++ b/exchange/exchange-ps/exchange/Get-MailUser.md @@ -55,6 +55,19 @@ Get-MailUser [[-Identity] ] ### LOBAppAccount ``` Get-MailUser [-LOBAppAccount] + [-Filter ] + [-OrganizationalUnit ] + [-ProgressAction ] + [-ResultSize ] + [-SharedWithMailUser] + [-SoftDeletedMailUser] + [-SortBy ] + [] +``` + +### HVEAccount +``` +Get-MailUser [-HVEAccount] [-Filter ] [-OrganizationalUnit ] [-ResultSize ] @@ -193,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. diff --git a/exchange/exchange-ps/exchange/Get-Mailbox.md b/exchange/exchange-ps/exchange/Get-Mailbox.md index 188835a81f..cae3773fe1 100644 --- a/exchange/exchange-ps/exchange/Get-Mailbox.md +++ b/exchange/exchange-ps/exchange/Get-Mailbox.md @@ -39,6 +39,8 @@ Get-Mailbox [-Anr ] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] [-IncludeEmailAddressDisplayNames] + [-IncludeForwardingAddressWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-IncludeInactiveMailbox] [-Migration] [-Monitoring] @@ -48,7 +50,6 @@ Get-Mailbox [-Anr ] [-RecipientTypeDetails ] [-RemoteArchive] [-ResultSize ] - [-ServiceSafetyConfiguration] [-SoftDeletedMailbox] [-SortBy ] [-SupervisoryReviewPolicy] @@ -97,6 +98,8 @@ Get-Mailbox [[-Identity] ] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] [-IncludeEmailAddressDisplayNames] + [-IncludeForwardingAddressWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-IncludeInactiveMailbox] [-Migration] [-Monitoring] @@ -106,7 +109,6 @@ Get-Mailbox [[-Identity] ] [-RecipientTypeDetails ] [-RemoteArchive] [-ResultSize ] - [-ServiceSafetyConfiguration] [-SoftDeletedMailbox] [-SortBy ] [-SupervisoryReviewPolicy] @@ -149,13 +151,14 @@ Get-Mailbox [-MailboxPlan ] [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAcceptMessagesOnlyFromWithDisplayNames] [-IncludeEmailAddressDisplayNames] + [-IncludeForwardingAddressWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-IncludeInactiveMailbox] [-Migration] [-OrganizationalUnit ] [-PublicFolder] [-RecipientTypeDetails ] [-ResultSize ] - [-ServiceSafetyConfiguration] [-SoftDeletedMailbox] [-SortBy ] [] @@ -558,6 +561,42 @@ 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. @@ -802,24 +841,6 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -ServiceSafetyConfiguration -This parameter is available only in the cloud-based service. - -{{ Fill ServiceSafetyConfiguration 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 -``` - ### -SoftDeletedMailbox This parameter is available only in the cloud-based service. 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-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-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md index 84c1c819d6..fff93d6e2a 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md @@ -26,6 +26,7 @@ Get-MailboxMessageConfiguration [-Identity] [-DomainController ] [-ReadFromDomainController] [-ResultSize ] + [-SignatureName ] [-UseCustomRouting] [] ``` @@ -155,6 +156,24 @@ 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. diff --git a/exchange/exchange-ps/exchange/Get-MailboxPermission.md b/exchange/exchange-ps/exchange/Get-MailboxPermission.md index a0b437a56d..80fc4e6f73 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxPermission.md +++ b/exchange/exchange-ps/exchange/Get-MailboxPermission.md @@ -28,6 +28,7 @@ Get-MailboxPermission [-Identity] [-Owner] [-Credential ] [-DomainController ] [-GroupMailbox] + [-IncludeUserWithDisplayName] [-ReadFromDomainController] [-ResultSize ] [-UseCustomRouting] @@ -42,6 +43,7 @@ Get-MailboxPermission [-Identity] [-User ] [-UseCustomRouting] @@ -213,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. 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-MailboxUsageReport.md b/exchange/exchange-ps/exchange/Get-MailboxUsageReport.md deleted file mode 100644 index eef9eefee7..0000000000 --- a/exchange/exchange-ps/exchange/Get-MailboxUsageReport.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxusagereport -applicable: Exchange Online -title: Get-MailboxUsageReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-MailboxUsageReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://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. - -For 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 ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, 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 -``` - -This example retrieves the number of mailboxes that were near or over the maximum mailbox size between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## INPUTS - -### Input types -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### Output types -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md b/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md index aba9315f37..fef6949dce 100644 --- a/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md +++ b/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md @@ -2,26 +2,26 @@ external help file: Microsoft.Exchange.ServerStatus-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/get-mailflowstatusreport applicable: Exchange Online, Exchange Online Protection -title: Get-MailflowStatusReport +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 ] @@ -95,7 +95,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 @@ -186,7 +186,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-MessageTrace.md b/exchange/exchange-ps/exchange/Get-MessageTrace.md index 94395d03c8..9c5967a9f2 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrace.md +++ b/exchange/exchange-ps/exchange/Get-MessageTrace.md @@ -64,7 +64,7 @@ This example retrieves message trace information for messages sent by john@conto ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -218,7 +218,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md b/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md index a4af3ced4f..716d8c1509 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md +++ b/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md @@ -120,7 +120,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. @@ -246,7 +246,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. 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 09b3c5d92c..e123a060c9 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md +++ b/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md @@ -48,7 +48,9 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ```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-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-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-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md index 266aa1bc97..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 Microsoft Entra ID, 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-Notification.md b/exchange/exchange-ps/exchange/Get-Notification.md index 4b28c302f0..a354e891db 100644 --- a/exchange/exchange-ps/exchange/Get-Notification.md +++ b/exchange/exchange-ps/exchange/Get-Notification.md @@ -14,6 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +> [!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. @@ -189,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 c19ad95497..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/2017 -EndDate 05/03/2017 -``` - -This example retrieves the browser details for the user john@contoso.com between May 1, 2017 and May 3, 2017. - -### 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 224cc61d81..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/2017 -EndDate 05/03/2017 -``` - -This example retrieves the operating system details for user John between May 1, 2017 and May 3, 2017. - -### 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 739a38dfa9..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/2014 -EndDate 06/15/2014 -``` - -This example retrieves the client operating system information between June 13, 2014 and June 15, 2014. - -## 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-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-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 53de9a181b..c13137555b 100644 --- a/exchange/exchange-ps/exchange/Get-Place.md +++ b/exchange/exchange-ps/exchange/Get-Place.md @@ -62,7 +62,7 @@ This example returns detailed metadata for Conference Room 1. Get-Place -Type Room ``` -This example returns all room mailboxes. +This example returns all room mailboxes. ## PARAMETERS @@ -128,7 +128,7 @@ The Type parameter filters the results by the type of room mailbox. Valid values - Room - RoomList -- Space +- Space You can't use this parameter with the Identity parameter. 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 fc22a7a7e2..7e98a8ee18 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md @@ -38,6 +38,7 @@ Get-QuarantineMessage [-EndExpiresDate ] [-EndReceivedDate ] [-EntityType ] + [-IncludeMessagesFromBlockedSenderAddress] [-MessageId ] [-MyItems] [-Page ] @@ -140,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[] @@ -158,7 +159,7 @@ 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. @@ -178,7 +179,7 @@ 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 @@ -199,6 +200,7 @@ 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 @@ -213,6 +215,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeMessagesFromBlockedSenderAddress +The IncludeMessagesFromBlockedSenderAddress switch specifies whether to include quarantined messages from blocked senders in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +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, `""`). @@ -302,6 +320,7 @@ 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 (Microsoft Defender for Office 365 only) @@ -325,6 +344,7 @@ 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 (anti-malware policies in EOP or Safe Attachments policies in Defender for Office 365) @@ -369,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. @@ -399,6 +419,8 @@ The ReleaseStatus parameter filters the results by the release status of the mes 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 @@ -450,7 +472,7 @@ 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. @@ -470,7 +492,7 @@ 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. @@ -530,6 +552,7 @@ Accept wildcard characters: False The Type parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk +- DataLossPrevention - HighConfPhish - Malware - Phish diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md index 164dfb8612..9dac21f945 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md @@ -76,6 +76,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md index 4d79c3b3c3..93177a8f2a 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md @@ -27,7 +27,7 @@ Get-QuarantinePolicy [[-Identity] ] ``` ## DESCRIPTION -Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features) and quarantine notification settings. For more information, see [Quarantine policies](https://learn.microsoft.com/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). 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-RecoverableItems.md b/exchange/exchange-ps/exchange/Get-RecoverableItems.md index 56753e6d94..aebb11746e 100644 --- a/exchange/exchange-ps/exchange/Get-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Get-RecoverableItems.md @@ -136,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 @@ -176,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 diff --git a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md index 1dd04224b0..fbb20052f5 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md @@ -26,6 +26,7 @@ Get-RetentionCompliancePolicy [[-Identity] ] [-ErrorPolicyOnly] [-ExcludeTeamsPolicy] [-IncludeTestModeResults] + [-PriorityCleanup] [-RetentionRuleTypes] [-TeamsPolicyOnly] [] @@ -147,10 +148,26 @@ 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 a5b8eb2814..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] [] ``` @@ -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-RoleGroup.md b/exchange/exchange-ps/exchange/Get-RoleGroup.md index 845dc99bd0..7e6cfdc324 100644 --- a/exchange/exchange-ps/exchange/Get-RoleGroup.md +++ b/exchange/exchange-ps/exchange/Get-RoleGroup.md @@ -24,7 +24,6 @@ For information about the parameter sets in the Syntax section below, see [Excha Get-RoleGroup [[-Identity] ] [-DomainController ] [-Filter ] - [-Organization ] [-ReadFromDomainController] [-ResultSize ] [-ShowPartnerLinked] @@ -139,24 +138,6 @@ 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 -``` - ### -ReadFromDomainController This parameter is available only in on-premises Exchange. 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 84db3a9c2f..1330056090 100644 --- a/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md @@ -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). diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md index d403bb4d7f..0dded56904 100644 --- a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md @@ -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). 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 4650fa4a60..ef6379a4e6 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md @@ -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-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md index 9d9ae39749..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, Exchange Online Protection +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, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 0 @@ -66,7 +68,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn 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-ServicePrincipal.md b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md index 21e62a3e09..ee06d9d363 100644 --- a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md @@ -29,7 +29,7 @@ Get-ServicePrincipal [[-Identity] ] ## DESCRIPTION Service principals exist in Microsoft Entra ID to define what apps can do, who can access the apps, and what resources the apps can access. In Exchange Online, service principals are references to the service principals in Microsoft Entra ID. To assign Exchange Online role-based access control (RBAC) roles to service principals in Microsoft Entra ID, you use the service principal references in Exchange Online. The **\*-ServicePrincipal** cmdlets in Exchange Online PowerShell let you view, create, and remove these service principal references. -For more information, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/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). 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 83e0e0a704..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 Viva Engage. -- 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 4c632e51b0..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). 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 f719f9df57..420045a251 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md @@ -49,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 @@ -83,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 7be8c76e68..3a432c1505 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md @@ -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 b2cf057af9..d3982ce31b 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md @@ -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-SupervisoryReviewReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md index a01ccb9f26..5e1a033aa5 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md @@ -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 ac82f7525f..1a7f812f23 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-SupervisoryReviewRule [[-Identity] ] + [-IncludeRuleXml] [-Policy ] [] ``` @@ -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 7a57173674..f630b5e84b 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md @@ -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 b0e0b8606e..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 @@ -85,7 +85,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 +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md index c31660ec35..f2a8862ef7 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md @@ -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. diff --git a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md index f1ef43271d..07a961fcf8 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md @@ -32,7 +32,7 @@ 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/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 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/purview/microsoft-365-compliance-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-UnifiedGroup.md b/exchange/exchange-ps/exchange/Get-UnifiedGroup.md index 2349632985..0d661079bb 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Get-UnifiedGroup.md @@ -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 ] @@ -158,6 +168,24 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeAllProperties The IncludeAllProperties switch specifies whether to include the values of all properties in the results. You don't need to specify a value with this switch. @@ -176,6 +204,78 @@ 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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeSoftDeletedGroups The IncludeSoftDeletedGroups switch specifies whether to include soft-deleted Microsoft 365 Groups in the results. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Get-User.md b/exchange/exchange-ps/exchange/Get-User.md index 8e8520af67..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. diff --git a/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md b/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md index 35de6e1d56..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 Microsoft Entra ID, 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-VivaInsightsSettings.md b/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md index f279f5644b..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 Microsoft Entra ID, 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 index 184f442796..b2787501f8 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md @@ -10,14 +10,11 @@ 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). -**Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. - 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). @@ -123,4 +120,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) -[Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids) +[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 index c752b66384..8fed8e655e 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md @@ -15,8 +15,6 @@ ms.reviewer: ## 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). -**Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. - 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). @@ -36,9 +34,12 @@ 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. +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). -To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/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 @@ -141,4 +142,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) -[Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids) +[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 index 8cc75fd525..1e4a57e8a1 100644 --- a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -15,33 +15,45 @@ ms.reviewer: ## 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). -**Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. - -Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module. 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. +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 -FeatureId -ModuleId - [[-PolicyId] ] - [-ResultSize ] +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. +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. -You can view all policies for a specified feature in a Viva module. 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 to run this cmdlet. +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 administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). +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 @@ -59,6 +71,20 @@ Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Policy 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 @@ -68,7 +94,7 @@ To view details about the features in a Viva module that support feature access ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: FeaturePolicy Aliases: Applicable: Exchange Online @@ -79,6 +105,19 @@ 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. @@ -102,7 +141,7 @@ To view details about all policies for a feature in a Viva module, run this cmdl ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: FeaturePolicy Aliases: Applicable: Exchange Online @@ -113,6 +152,24 @@ 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. @@ -144,4 +201,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) -[Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids) +[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/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 fb4051850f..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 diff --git a/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md b/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md index 3273303524..30fae12016 100644 --- a/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md +++ b/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/import-transportrulecollection -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Import-TransportRuleCollection schema: 2.0.0 author: chrisda @@ -12,7 +12,7 @@ ms.reviewer: # Import-TransportRuleCollection ## SYNOPSIS -This cmdlet is available only in on-premises Exchange. +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. @@ -62,7 +62,7 @@ The Identity parameter specifies the transport rule that you want to import. You Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -80,7 +80,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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -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 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,6 +109,8 @@ 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. The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. @@ -135,7 +137,7 @@ You can use this switch to run tasks programmatically where prompting for admini Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,7 +153,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 +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/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/New-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md index d48f33ce24..85953675d6 100644 --- a/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md @@ -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). diff --git a/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md index 8ce36d59ee..9397716f14 100644 --- a/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md @@ -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). @@ -275,7 +275,7 @@ The RecipientDomainIs parameter specifies a condition that looks for recipients Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Onlinen +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 c6591a6590..0000000000 --- a/exchange/exchange-ps/exchange/New-ActivityAlert.md +++ /dev/null @@ -1,470 +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). - -**Note**: Activity alerts have been effectively replaced by alert policies and the corresponding **\*-ProtectionAlert** cmdlets. For more information about alert policies, see [Alert policies in Microsoft 365](https://learn.microsoft.com/purview/alert-policies). - -Use the New-ActivityAlert cmdlet to create activity alerts. Activity alerts send 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 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/purview/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/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"`. - -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-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-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 5123a1702a..412a2a5340 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md @@ -127,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 available only 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 @@ -167,7 +167,7 @@ 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 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: 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. @@ -431,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 @@ -478,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 @@ -587,8 +587,8 @@ The MailboxIntelligenceProtectionAction parameter specifies what to do with mess - 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 available only 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. @@ -635,9 +635,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -712,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 @@ -750,9 +750,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -797,8 +797,8 @@ The TargetedDomainProtectionAction parameter specifies the action to take on det - 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 available only 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 @@ -823,9 +823,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -890,8 +890,8 @@ The TargetedUserProtectionAction parameter specifies the action to take on detec - 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 available only 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 @@ -916,9 +916,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -946,7 +946,6 @@ This parameter uses the syntax: "DisplayName;EmailAddress". - 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. - ```yaml Type: MultiValuedProperty Parameter Sets: (All) diff --git a/exchange/exchange-ps/exchange/New-AntiPhishRule.md b/exchange/exchange-ps/exchange/New-AntiPhishRule.md index a5015e817b..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). diff --git a/exchange/exchange-ps/exchange/New-App.md b/exchange/exchange-ps/exchange/New-App.md index 0339561d39..12f88e9b57 100644 --- a/exchange/exchange-ps/exchange/New-App.md +++ b/exchange/exchange-ps/exchange/New-App.md @@ -151,7 +151,7 @@ This parameter is available only in the cloud-based service. {{ Fill AddInOverrides Description }} ```yaml -Type: Object +Type: AddInOverrides Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -185,7 +185,7 @@ This parameter is available only in the cloud-based service. {{ Fill AllowSetting Description }} ```yaml -Type: Object +Type: AllowSetting Parameter Sets: (All) Aliases: Applicable: Exchange Online diff --git a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md index c3787439cd..669e94235e 100644 --- a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md @@ -50,7 +50,9 @@ New-AppRetentionCompliancePolicy [-Name] -Applications ``` ## DESCRIPTION -\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies that cover Teams private channels, Viva Engage chats, and Viva Engage community messages. Eventually, you'll use these cmdlets for most retention locations and policy types. The \*-RetentionCompliance\* cmdlets will continue to support Exchange and SharePoint locations primarily. For policies created with the \*-AppRetentionCompliance\* cmdlets, you can only set the list of included or excluded scopes for all included workloads, which means you'll likely need to create one policy per workload. +\*-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). @@ -104,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"` -- ExchangeLocation -- ModernGroupLocation -- AdaptiveScopeLocation +- **Microsoft Copilot experiences**: Currently in Preview. You must use *all* of the following values at the same time: -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:VivaEngage"`. + `"User:M365Copilot,CopilotForSecurity,CopilotinFabricPowerBI,CopilotStudio,CopilotinBusinessApplicationplatformsSales,SQLCopilot"` + + **Note**: Even though you must use `CopilotinBusinessApplicationplatformsSales` and `SQLCopilot`, those values are currently irrelevant. + +- **Enterprise AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"` + +- **Other AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:CloudAIAppChatGPTConsumer,CloudAIAppGoogleGemini,BingConsumer,DeepSeek"` ```yaml Type: String[] @@ -308,6 +328,8 @@ 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. diff --git a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md index 6679091837..fde925d045 100644 --- a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md @@ -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) diff --git a/exchange/exchange-ps/exchange/New-AuditConfigurationRule.md b/exchange/exchange-ps/exchange/New-AuditConfigurationRule.md deleted file mode 100644 index 6970a6584f..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/purview/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-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 9301ebb11e..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] [] @@ -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 6f23198d1d..3cf6734ddf 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). @@ -35,6 +35,7 @@ New-AutoSensitivityLabelPolicy [-Name] -ApplySensitivityLabel [-ExchangeSenderMemberOfException ] [-ExternalMailRightsManagementOwner ] [-Force] + [-Locations ] [-Mode ] [-OneDriveAdaptiveScopes ] [-OneDriveAdaptiveScopesException ] @@ -364,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: diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md index b5200f9dda..43a5384ec8 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md @@ -76,6 +76,7 @@ New-AutoSensitivityLabelRule [-Name] -Policy -Workl [-SenderIPRanges ] [-SentTo ] [-SentToMemberOf ] + [-SourceType ] [-SubjectMatchesPatterns ] [-WhatIf] [] @@ -253,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) @@ -1212,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 a98d4b73da..7019d149b7 100644 --- a/exchange/exchange-ps/exchange/New-AvailabilityConfig.md +++ b/exchange/exchange-ps/exchange/New-AvailabilityConfig.md @@ -14,16 +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] [] ``` @@ -35,53 +36,39 @@ 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 Accept wildcard characters: False ``` -### -AllowedTenantIds -{{ Fill AllowedTenantIds Description }} +### -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: MultiValuedProperty +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: Exchange Online Required: False @@ -91,16 +78,13 @@ 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. +### -OrgWideAccount +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: SecurityPrincipalIdParameter Parameter Sets: (All) -Aliases: cf +Aliases: Applicable: Exchange Online Required: False diff --git a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md index 7119a38bff..0564008fde 100644 --- a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md @@ -16,9 +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. -**Note**: 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). - -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). diff --git a/exchange/exchange-ps/exchange/New-ClientAccessRule.md b/exchange/exchange-ps/exchange/New-ClientAccessRule.md index 8157f8a884..af5e934438 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/New-ClientAccessRule.md @@ -13,7 +13,7 @@ ms.reviewer: ## SYNOPSIS > [!NOTE] -> Beginning in October 2022, we've disabled access to client access rules for all existing Exchange Online organizations that weren't using them. In September 2024, support for client access rules will end for all Exchange Online organizations. For more information, see [Update: Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/update-deprecation-of-client-access-rules-in-exchange-online/ba-p/3790165). +> 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. diff --git a/exchange/exchange-ps/exchange/New-ComplianceCase.md b/exchange/exchange-ps/exchange/New-ComplianceCase.md index 11f82bf76c..6366bff3d0 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/New-ComplianceCase.md @@ -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 8d451f9658..8cb6b6f70b 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md @@ -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. diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearch.md b/exchange/exchange-ps/exchange/New-ComplianceSearch.md index edae6f0f9d..c3cd46e78f 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSearch.md @@ -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. diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md index 779ed7b5c7..bd3b087cb4 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md @@ -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 @@ -134,6 +136,8 @@ New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointA 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 @@ -212,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 @@ -228,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. @@ -257,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. @@ -279,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 @@ -351,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: @@ -388,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. @@ -408,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. @@ -451,6 +470,9 @@ Accept wildcard characters: False 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. + + **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. @@ -522,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. @@ -540,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 @@ -574,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: +- GenerateReportsOnly +- Inventory +- RetentionReports +- TriagePreview ```yaml Type: ComplianceSearchActionScenario @@ -597,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 @@ -637,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. @@ -663,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-ComplianceTag.md b/exchange/exchange-ps/exchange/New-ComplianceTag.md index f798cdc1a6..9de8c0fca4 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/New-ComplianceTag.md @@ -20,6 +20,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### Default ``` New-ComplianceTag [-Name] [-AutoApprovalPeriod ] @@ -43,6 +44,18 @@ 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/purview/microsoft-365-compliance-center-permissions). @@ -77,11 +90,126 @@ 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: Object +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -341,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-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md index f8981ae256..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 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/purview/microsoft-365-compliance-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 4c02a0649e..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 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/purview/microsoft-365-compliance-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-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md index 0ef876700c..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 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/purview/microsoft-365-compliance-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 ea587817c5..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 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/purview/microsoft-365-compliance-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-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md index 9c440654f2..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 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/purview/microsoft-365-compliance-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 0aef5f8641..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 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/purview/microsoft-365-compliance-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 f315763576..de47db246c 100644 --- a/exchange/exchange-ps/exchange/New-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/New-DistributionGroup.md @@ -304,7 +304,7 @@ The HiddenGroupMembershipEnabled switch specifies whether to hide the members of You can use this setting to help comply with regulations that require you to hide group membership from 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 @@ -346,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 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 e94cf4bc59..6f9c54bfdf 100644 --- a/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md @@ -26,8 +26,10 @@ New-DlpCompliancePolicy [-Name] [-Confirm] [-EndpointDlpAdaptiveScopes ] [-EndpointDlpAdaptiveScopesException ] + [-EndpointDlpExtendedLocations ] [-EndpointDlpLocation ] [-EndpointDlpLocationException ] + [-EnforcementPlanes ] [-ExceptIfOneDriveSharedBy ] [-ExceptIfOneDriveSharedByMemberOf ] [-ExchangeAdaptiveScopes ] @@ -36,6 +38,8 @@ New-DlpCompliancePolicy [-Name] [-ExchangeSenderMemberOf ] [-ExchangeSenderMemberOfException ] [-Force] + [-IsFromSmartInsights ] + [-Locations ] [-Mode ] [-OneDriveAdaptiveScopes ] [-OneDriveAdaptiveScopesException ] @@ -60,6 +64,7 @@ New-DlpCompliancePolicy [-Name] [-TeamsLocationException ] [-ThirdPartyAppDlpLocation ] [-ThirdPartyAppDlpLocationException ] + [-ValidatePolicy] [-WhatIf] [] ``` @@ -84,13 +89,67 @@ New-DlpCompliancePolicy -Name "GlobalPolicy" -Comment "Primary policy" -SharePoi 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. ### 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 @@ -176,6 +235,22 @@ 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 Microsoft Entra ID. @@ -220,6 +295,26 @@ 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). @@ -390,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 @@ -869,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 e472c978ab..e8be39fdba 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -31,6 +31,7 @@ New-DlpComplianceRule [-Name] -Policy [-AnyOfRecipientAddressMatchesPatterns ] [-ApplyBrandingTemplate ] [-ApplyHtmlDisclaimer ] + [-AttachmentIsNotLabeled ] [-BlockAccess ] [-BlockAccessScope ] [-Comment ] @@ -52,10 +53,12 @@ New-DlpComplianceRule [-Name] -Policy [-DocumentNameMatchesPatterns ] [-DocumentNameMatchesWords ] [-DocumentSizeOver ] + [-DomainCountOver ] [-EncryptRMSTemplate ] [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] [-EnforcePortalAccess ] + [-EvaluateRulePerComponent ] [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] @@ -113,8 +116,10 @@ New-DlpComplianceRule [-Name] -Policy [-HeaderMatchesPatterns ] [-ImmutableId ] [-IncidentReportContent ] + [-MessageIsNotLabeled ] [-MessageSizeOver ] [-MessageTypeMatches ] + [-MipRestrictAccess ] [-Moderate ] [-ModifySubject ] [-NonBifurcatingAccessScope ] @@ -123,8 +128,10 @@ New-DlpComplianceRule [-Name] -Policy [-NotifyEmailCustomSubject ] [-NotifyEmailCustomText ] [-NotifyEmailExchangeIncludeAttachment ] + [-NotifyEmailOnedriveRemediationActions ] [-NotifyEndpointUser ] [-NotifyOverrideRequirements ] + [-NotifyPolicyTipCustomDialog ] [-NotifyPolicyTipCustomText ] [-NotifyPolicyTipCustomTextTranslations ] [-NotifyPolicyTipDisplayOption ] @@ -138,11 +145,13 @@ New-DlpComplianceRule [-Name] -Policy [-Quarantine ] [-RecipientADAttributeContainsWords ] [-RecipientADAttributeMatchesPatterns ] + [-RecipientCountOver ] [-RecipientDomainIs ] [-RedirectMessageTo ] [-RemoveHeader ] [-RemoveRMSTemplate ] [-ReportSeverityLevel ] + [-RestrictAccess ] [-RestrictBrowserAccess ] [-RuleErrorAction ] [-SenderADAttributeContainsWords ] @@ -160,7 +169,9 @@ New-DlpComplianceRule [-Name] -Policy [-SubjectOrBodyContainsWords ] [-SubjectOrBodyMatchesPatterns ] [-ThirdPartyAppDlpRestrictions ] + [-TriggerPowerAutomateFlow ] [-UnscannableDocumentExtensionIs ] + [-ValidateRule] [-WhatIf] [-WithImportance ] [] @@ -296,6 +307,22 @@ New-DLPComplianceRule -Name "Contoso Rule 1" -Policy "Contoso Policy 1" -Advance 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 @@ -512,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: @@ -659,7 +702,12 @@ Accept wildcard characters: False ``` ### -ContentIsNotLabeled -{{ Fill ContentIsNotLabeled 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 @@ -675,7 +723,12 @@ 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 @@ -748,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 @@ -764,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[] @@ -904,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 ("). @@ -996,6 +1069,34 @@ 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: @@ -1133,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 @@ -1187,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 @@ -1203,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[] @@ -2267,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. @@ -2322,6 +2448,22 @@ 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"}`. @@ -2480,6 +2622,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NotifyEmailOnedriveRemediationActions +{{ Fill NotifyEmailOnedriveRemediationActions Description }} + +```yaml +Type: NotifyEmailRemediationActions +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NotifyEndpointUser **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. @@ -2516,6 +2674,22 @@ 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. @@ -2831,6 +3005,24 @@ 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 addresses in the specified domains. You can specify multiple domains separated by commas. @@ -2927,6 +3119,22 @@ 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 }} @@ -3188,7 +3396,13 @@ Accept wildcard characters: False ``` ### -SharedByIRMUserRisk -{{ Fill SharedByIRMUserRisk Description }} +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 @@ -3320,6 +3534,22 @@ 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 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. @@ -3338,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. 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-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md index 89c0e46b8f..0f0e180485 100644 --- a/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md @@ -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). 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-HoldComplianceRule.md b/exchange/exchange-ps/exchange/New-HoldComplianceRule.md index a2c4480ef5..9ebebdb7c5 100644 --- a/exchange/exchange-ps/exchange/New-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-HoldComplianceRule.md @@ -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 diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md index 57461eac97..ef6356928d 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md @@ -167,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"`. @@ -189,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"`. @@ -211,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"`. @@ -233,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"`. @@ -259,9 +259,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -284,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/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 @@ -305,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 @@ -531,9 +531,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -556,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/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 @@ -580,9 +580,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -702,7 +702,7 @@ Accept wildcard characters: False 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, this value is the same as HighConfidencePhish. -- 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. @@ -1010,9 +1010,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -1035,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 @@ -1101,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 @@ -1171,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 Junk Email folder in hybrid environments](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 @@ -1195,9 +1195,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md index a7f4f574d9..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 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). 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 ca3bf62f62..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) diff --git a/exchange/exchange-ps/exchange/New-InboxRule.md b/exchange/exchange-ps/exchange/New-InboxRule.md index beb9c67601..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 @@ -694,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. @@ -714,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. @@ -1403,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. @@ -1423,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. diff --git a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md index 36dda44406..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] [] ``` @@ -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: diff --git a/exchange/exchange-ps/exchange/New-Label.md b/exchange/exchange-ps/exchange/New-Label.md index eaa9ca47ad..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,12 @@ New-Label [-Name] -DisplayName -Tooltip [-SiteExternalSharingControlType ] [-TeamsAllowedPresenters ] [-TeamsAllowMeetingChat ] + [-TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch ] [-TeamsBypassLobbyForDialInUsers ] + [-TeamsChannelProtectionEnabled ] + [-TeamsChannelSharedWithExternalTenants ] + [-TeamsChannelSharedWithPrivateTeamsOnly ] + [-TeamsChannelSharedWithSameLabelOnly ] [-TeamsCopyRestrictionEnforced ] [-TeamsEndToEndEncryptionEnabled ] [-TeamsLobbyBypassScope ] @@ -162,10 +169,12 @@ 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: +- **BlockContentAnalysisServices**: Specifies a privacy setting to allow or prevent content in Word, Excel, PowerPoint, and Outlook from being sent to Microsoft for content analysis. Available values are True, and False (the default). This setting impacts services such as data loss prevention policy tips, automatic and recommended labeling, and Microsoft Copilot for Microsoft 365. Example: `New-Label -Identity Confidential -AdvancedSettings @{BlockContentAnalysisServices="True"}`. For more information, see [Prevent some connected experiences that analyze content](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#prevent-some-connected-experiences-that-analyze-content). + - **Color**: Specifies a label color as a hex triplet code for the red, green, and blue (RGB) components of the color. Example: `New-Label -DisplayName "General" -Name "General" -Tooltip "Business data that is not intended for public consumption." -AdvancedSettings @{color="#40e0d0"}`. For more information, see [Configuring custom colors by using PowerShell](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configuring-custom-colors-by-using-powershell). - **DefaultSharingScope**: Specifies the default sharing link type for a site when the label scope includes **Groups & sites**, and the default sharing link type for a document when the label scope includes **Files & emails**. Available values are SpecificPeople, Organization, and Anyone. Example: `New-Label DisplayName "General" -Name "General" -Tooltip "Business data that is not intended for public consumption." -AdvancedSettings @{DefaultSharingScope="SpecificPeople"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). @@ -297,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 @@ -430,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 @@ -463,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: @@ -684,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']"`. @@ -1304,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: @@ -1324,6 +1395,70 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamsChannelProtectionEnabled +{{ Fill TeamsChannelProtectionEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithExternalTenants +{{ Fill TeamsChannelSharedWithExternalTenants Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithPrivateTeamsOnly +{{ Fill TeamsChannelSharedWithPrivateTeamsOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithSameLabelOnly +{{ Fill TeamsChannelSharedWithSameLabelOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TeamsCopyRestrictionEnforced The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: diff --git a/exchange/exchange-ps/exchange/New-LabelPolicy.md b/exchange/exchange-ps/exchange/New-LabelPolicy.md index 99b8ebe759..ce59ac07c5 100644 --- a/exchange/exchange-ps/exchange/New-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/New-LabelPolicy.md @@ -102,7 +102,7 @@ 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: @@ -110,6 +110,8 @@ 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: `New-LabelPolicy -Identity Global -AdvancedSettings @{EnableAudit="False"}`. +- **EnableRevokeGuiSupport**: Remove the Track & Revoke button from the sensitivity menu in Office clients. Supported apps: Word, Excel, and PowerPoint on Windows (version 2406+). Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{EnableRevokeGuiSupport="False"}`. For more information about this configuration choice, see [Track and revoke document access](https://learn.microsoft.com/purview/track-and-revoke-admin). + - **DisableMandatoryInOutlook**: Outlook apps that support this setting exempt Outlook messages from mandatory labeling. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{DisableMandatoryInOutlook="True"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). - **DisableShowSensitiveContent**: For Office apps that highlight the sensitive content that caused a label to be recommended, turn off these highlights and corresponding indications about the sensitive content. For more information, see [Sensitivity labels are automatically applied or recommended for your files and emails in Office](https://support.microsoft.com/office/sensitivity-labels-are-automatically-applied-or-recommended-for-your-files-and-emails-in-office-622e0d9c-f38c-470a-bcdb-9e90b24d71a1). Supported apps: Word for Windows (version 2311+). Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{DisableShowSensitiveContent="True"}` diff --git a/exchange/exchange-ps/exchange/New-MailMessage.md b/exchange/exchange-ps/exchange/New-MailMessage.md index 278ef4768e..c016c6ef01 100644 --- a/exchange/exchange-ps/exchange/New-MailMessage.md +++ b/exchange/exchange-ps/exchange/New-MailMessage.md @@ -43,7 +43,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi New-MailMessage -Subject "Delivery Report" -Body "Click here to view this report" -Mailbox tony ``` -In Exchange Server 2010, this example creates an message in the Drafts folder of Tony's mailbox, with the subject and body specified by the Subject and Body parameters. The message body is rendered in plain text because no format for the message body is specified. +In Exchange Server 2010, this example creates a message in the Drafts folder of Tony's mailbox, with the subject and body specified by the Subject and Body parameters. The message body is rendered in plain text because no format for the message body is specified. ### Example 2 ```powershell @@ -71,7 +71,7 @@ This example creates an empty email message in the Drafts folder because no subj New-MailMessage -Subject "Delivery Information" -Body "Click here to see details" -Mailbox tony -BodyFormat Html ``` -In Exchange Server 2010, this example creates an message in the Drafts folder of Tony's mailbox with the subject and body specified by the Subject and Body parameters. The message body is rendered in HTML format. +In Exchange Server 2010, this example creates a message in the Drafts folder of Tony's mailbox with the subject and body specified by the Subject and Body parameters. The message body is rendered in HTML format. ### Example 6 ```powershell diff --git a/exchange/exchange-ps/exchange/New-MailUser.md b/exchange/exchange-ps/exchange/New-MailUser.md index 55d69952bd..27ea5d62e4 100644 --- a/exchange/exchange-ps/exchange/New-MailUser.md +++ b/exchange/exchange-ps/exchange/New-MailUser.md @@ -125,6 +125,27 @@ 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] @@ -140,6 +161,7 @@ New-MailUser [-Name] -Password [-LOBAppAccount] [-ModerationEnabled ] [-OrganizationalUnit ] [-PrimarySmtpAddress ] + [-ProgressAction ] [-RemotePowerShellEnabled ] [-SendModerationNotifications ] [-WhatIf] @@ -318,7 +340,7 @@ You can use the following methods as a value for this parameter: ```yaml Type: SecureString -Parameter Sets: EnabledUser, LOBAppAccount, 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 @@ -531,6 +553,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: 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. @@ -738,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 23d0bad678..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 ] @@ -1888,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. @@ -1907,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. 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-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md index 67474c5f5e..43a1b13892 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md @@ -249,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 diff --git a/exchange/exchange-ps/exchange/New-MailboxSearch.md b/exchange/exchange-ps/exchange/New-MailboxSearch.md index 926caef04b..8c7db70175 100644 --- a/exchange/exchange-ps/exchange/New-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/New-MailboxSearch.md @@ -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 @@ -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 diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md index 61b41d3d59..0dd0822a20 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md @@ -209,7 +209,7 @@ Accept wildcard characters: False ### -CustomExternalBody 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 meaningful only when the the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters 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 @@ -434,7 +434,6 @@ You specify the file types using the FileTypes parameter. A default list of valu You specify the action for detected files using the FileTypeAction parameter. - ```yaml Type: Boolean Parameter Sets: (All) @@ -586,9 +585,9 @@ The QuarantineTag parameter specifies the quarantine policy that's used on messa - 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/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-policies#anatomy-of-a-quarantine-policy). +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`. @@ -608,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 5df745078a..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). diff --git a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md index 5de91eaebb..9cd0581b13 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md @@ -197,7 +197,7 @@ This parameter is available only in the cloud-based service. The App parameter specifies the service principal to assign the management role to. Specifically, the ObjectId GUID value from the output of the Get-ServicePrincipal cmdlet (for example, 6233fba6-0198-4277-892f-9275bf728bcc). -For more information about service principals, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/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. @@ -383,7 +383,7 @@ 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 Microsoft Entra ID](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 diff --git a/exchange/exchange-ps/exchange/New-ManagementScope.md b/exchange/exchange-ps/exchange/New-ManagementScope.md index 30292ebbdd..c2fcc0e2d9 100644 --- a/exchange/exchange-ps/exchange/New-ManagementScope.md +++ b/exchange/exchange-ps/exchange/New-ManagementScope.md @@ -406,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 78c1dca1f6..e17cdd2090 100644 --- a/exchange/exchange-ps/exchange/New-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/New-MigrationBatch.md @@ -44,7 +44,7 @@ New-MigrationBatch -Name -CSVData [-AllowIncrementalSyncs -CSVData +New-MigrationBatch -Name -CSVData [-Analyze] [-AllowUnknownColumnsInCSV ] [-AutoComplete] [-AutoStart] @@ -55,6 +55,7 @@ New-MigrationBatch -Name -CSVData [-NotificationEmails ] [-Partition ] [-ReportInterval ] + [-SkipDetails] [-SkipReports] [-SourceEndpoint ] [-StartAfter ] @@ -167,6 +168,29 @@ New-MigrationBatch -Name -CSVData -SourcePublicFolderDatabase [] ``` +### ManagedGmailTeams +``` +New-MigrationBatch -Name -CSVData [-ManagedGmailTeams] + [-AdoptPreexisting] + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-NotificationEmails ] + [-Partition ] + [-RemoveOnCopy] + [-ReportInterval ] + [-SkipCalendar] + [-SkipContacts] + [-SkipReports] + [-SourceEndpoint ] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + ### Offboarding ``` New-MigrationBatch -Name -CSVData [-DisallowExistingUsers] @@ -213,6 +237,7 @@ New-MigrationBatch -Name [-CSVData ] [-DisallowExistingUsers] [ [-ArchiveDomain ] [-ArchiveOnly] [-AutoComplete] + [-AutoProvisioning] [-AutoRetryCount ] [-AutoStart] [-AvoidMergeOverlap] @@ -221,11 +246,13 @@ New-MigrationBatch -Name [-CSVData ] [-DisallowExistingUsers] [ [-Confirm] [-ContentFilter ] [-ContentFilterLanguage ] + [-DataFusion] [-DomainController ] [-ExcludeDumpsters] [-ExcludeFolders ] [-ForwardingDisposition ] [-IncludeFolders ] + [-IncludeOtherContacts] [-LargeItemLimit ] [-Locale ] [-MigrateTasks] @@ -237,6 +264,7 @@ New-MigrationBatch -Name [-CSVData ] [-DisallowExistingUsers] [ [-RenamePrimaryCalendar] [-ReportInterval ] [-Restore] + [-SimplifiedSwitchOver] [-SkipCalendar] [-SkipContacts] [-SkipDelegates] @@ -255,6 +283,7 @@ New-MigrationBatch -Name [-CSVData ] [-DisallowExistingUsers] [ [-TargetDeliveryDomain ] [-TimeZone ] [-WhatIf] + [-XMLData ] [] ``` @@ -264,14 +293,14 @@ New-MigrationBatch -Name -CSVData [-AllowUnknownColumnsInCSV ] [-AutoComplete] [-AutoStart] - [-CompleteAfter ] + [-CompleteAfter ] [-Confirm] - [-NotificationEmails ] - [-Partition ] - [-ReportInterval ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] [-SkipReports] - [-StartAfter ] - [-TimeZone ] + [-StartAfter ] + [-TimeZone ] [-WhatIf] [] ``` @@ -282,14 +311,14 @@ New-MigrationBatch -Name -CSVData [-AllowUnknownColumnsInCSV ] [-AutoComplete] [-AutoStart] - [-CompleteAfter ] + [-CompleteAfter ] [-Confirm] - [-NotificationEmails ] - [-Partition ] - [-ReportInterval ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] [-SkipReports] - [-StartAfter ] - [-TimeZone ] + [-StartAfter ] + [-TimeZone ] [-WhatIf] [] ``` @@ -343,19 +372,19 @@ New-MigrationBatch -Name [-UserIds] ### PreexistingUsers ``` -New-MigrationBatch [-Users] -Name +New-MigrationBatch [-Users] MultiValuedProperty> -Name [-AllowUnknownColumnsInCSV ] [-AutoComplete] [-AutoStart] - [-CompleteAfter ] + [-CompleteAfter ] [-Confirm] [-DisableOnCopy] - [-NotificationEmails ] - [-Partition ] - [-ReportInterval ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] [-SkipReports] - [-StartAfter ] - [-TimeZone ] + [-StartAfter ] + [-TimeZone ] [-WhatIf] [] ``` @@ -588,7 +617,7 @@ To disable the migration of the users in the original migration batch, use the D ```yaml Type: MultiValuedProperty -Parameter Sets: Preexisting, PreexistingUsers +Parameter Sets: Preexisting, PreexistingUsers Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -599,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. @@ -624,7 +689,7 @@ A valid value for this parameter requires you to read the file to a byte-encoded ```yaml Type: Byte[] -Parameter Sets: Abch, Analysis, FolderMove, Local, LocalPublicFolder, Offboarding, XO1, PublicFolderToUnifiedGroup, GoogleResourceOnboarding, PointInTimeRecoveryProvisionOnly, PointInTimeRecovery +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 @@ -804,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. @@ -883,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: @@ -966,6 +1049,24 @@ 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. @@ -1164,6 +1265,24 @@ 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 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LargeItemLimit The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the migration request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used. @@ -1393,6 +1512,24 @@ 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. @@ -1400,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 @@ -1418,7 +1555,7 @@ 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 @@ -1447,6 +1584,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SkipDetails +This parameter is available only in the cloud-based service. + +{{ Fill SkipDetails Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Analysis +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SkipMail This parameter is available only in the cloud-based service. @@ -1616,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: @@ -1827,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 cf56590e9f..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 @@ -459,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. @@ -874,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. @@ -948,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-MoveRequest.md b/exchange/exchange-ps/exchange/New-MoveRequest.md index 4b73ef3600..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 ] @@ -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-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 2c1fca486f..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). @@ -449,7 +459,7 @@ Accept wildcard characters: False ### -NotifyUserSuppressionExpiryDate The NotifyUserSuppressionExpiryDate parameter specifies whether to temporarily suspend notifications for the alert policy. Until the specified date-time, no notifications are sent for detected activities. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime diff --git a/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md index 1a7b1b91bc..435cac68b3 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfoldermoverequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-PublicFolderMoveRequest schema: 2.0.0 author: chrisda @@ -12,7 +12,7 @@ ms.reviewer: # New-PublicFolderMoveRequest ## SYNOPSIS -This cmdlet is available only in on-premises Exchange. +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the New-PublicFolderMoveRequest cmdlet to begin the process of moving public folder contents between public folder mailboxes. Moving public folders only moves the physical contents of the public folder; it doesn't change the logical hierarchy. When the move request is completed, you must run the Remove-PublicFolderMoveRequest cmdlet to remove the request or wait until the time specified in the CompletedRequestAgeLimit parameter has passed. The request must be removed before you can run another move request. @@ -32,6 +32,7 @@ New-PublicFolderMoveRequest -Folders -TargetMailbox [-DomainController ] [-InternalFlags ] [-Name ] + [[-Organization] ] [-Priority ] [-RequestExpiryInterval ] [-Suspend] @@ -85,7 +86,7 @@ The Folders parameter specifies the public folders that you want to move. If the 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 @@ -112,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 @@ -130,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 @@ -148,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 @@ -166,7 +167,7 @@ Valid input for this parameter is an integer or the value unlimited. The default 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 @@ -182,7 +183,7 @@ The CompletedRequestAgeLimit parameter specifies how long the request will be ke 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 @@ -201,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 @@ -211,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 @@ -233,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 @@ -249,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 @@ -258,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: @@ -274,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 @@ -297,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 @@ -315,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 @@ -331,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 @@ -341,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. @@ -365,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 @@ -381,7 +404,7 @@ The WorkloadType parameter is reserved for internal Microsoft use. 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 b348f64c29..1d12b70c98 100644 --- a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md @@ -37,6 +37,7 @@ New-QuarantinePolicy [-Name] [-EndUserSpamNotificationLanguage ] [-EsnCustomSubject ] [-ESNEnabled ] + [-IncludeMessagesFromBlockedSenderAddress ] [-MultiLanguageCustomDisclaimer ] [-MultiLanguageSenderName ] [-MultiLanguageSetting ] @@ -47,7 +48,7 @@ New-QuarantinePolicy [-Name] ``` ## DESCRIPTION -Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features) and quarantine notification settings. For more information, see [Quarantine policies](https://learn.microsoft.com/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). @@ -194,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 @@ -216,7 +221,7 @@ This parameter uses a decimal value that's converted from a binary value. The bi - 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: This permission is not used (the value 0 or 1 does nothing). +- PermissionToAllowSender - PermissionToBlockSender - PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one value to 1 and the other value to 0, or set both values to 0. - PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one value to 1 and the other value to 0, or set both values to 0. This permission isn't honored for messages that were quarantined as malware or high confidence phishing. If the quarantine policy gives users this permission, users are allowed to request the release of their quarantined malware or high confidence phishing messages as if PermissionToRequestRelease was selected instead. @@ -226,8 +231,8 @@ This parameter uses a decimal value that's converted from a binary value. The bi 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. @@ -265,7 +270,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequency -The EndUserSpamNotificationFrequency parameter species how often quarantine notifications are sent to users. Valid values are: +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) @@ -327,7 +332,7 @@ To modify an existing value and preserve other values, you need to specify all e 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: +Type: MultiValuedProperty Parameter Sets: (All) Aliases: MultiValuedProperty Applicable: Exchange Online, Exchange Online Protection @@ -360,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. diff --git a/exchange/exchange-ps/exchange/New-ReceiveConnector.md b/exchange/exchange-ps/exchange/New-ReceiveConnector.md index 9d9ba24808..a053087232 100644 --- a/exchange/exchange-ps/exchange/New-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/New-ReceiveConnector.md @@ -1148,7 +1148,7 @@ Accept wildcard characters: False ### -MaxAcknowledgementDelay 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 09ac7e599e..2647a103bb 100644 --- a/exchange/exchange-ps/exchange/New-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/New-RemoteMailbox.md @@ -622,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 can use remote PowerShell. This is the default value. -- $false: The user can't use remote PowerShell. +- $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. + +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-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md index a32dabffdb..9128905359 100644 --- a/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md +++ b/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md @@ -53,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. diff --git a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md index 35ea5fc749..1d0a345f7c 100644 --- a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md @@ -37,11 +37,13 @@ New-RetentionCompliancePolicy [-Name] [-OneDriveLocationException ] [-PolicyRBACScopes ] [-PolicyTemplateInfo ] + [-PriorityCleanup] [-PublicFolderLocation ] [-RestrictiveRetention ] [-RetainCloudAttachment ] [-SharePointLocation ] [-SharePointLocationException ] + [-SkipPriorityCleanupConfirmation] [-SkypeLocation ] [-SkypeLocationException ] [-WhatIf] @@ -56,8 +58,10 @@ New-RetentionCompliancePolicy [-Name] [-Enabled ] [-Force] [-IsSimulation] + [-PriorityCleanup] [-RestrictiveRetention ] [-RetainCloudAttachment ] + [-SkipPriorityCleanupConfirmation] [-TeamsChannelLocation ] [-TeamsChannelLocationException ] [-TeamsChatLocation ] @@ -75,8 +79,10 @@ New-RetentionCompliancePolicy [-Name] -AdaptiveScopeLocation ] [-Force] [-IsSimulation] + [-PriorityCleanup] [-RestrictiveRetention ] [-RetainCloudAttachment ] + [-SkipPriorityCleanupConfirmation] [-WhatIf] [] ``` @@ -404,6 +410,8 @@ 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. @@ -437,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. @@ -545,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 d8b3c9c2f6..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] [] @@ -137,6 +141,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 +``` + ### -PublishComplianceTag The PublishComplianceTag parameter specifies the label that's published for the rule, which makes the label visible to users in apps (for example, Outlook, SharePoint, and OneDrive). A valid value for this parameter is the name of an existing label. If the value contains spaces, enclose the value in quotation marks. @@ -292,6 +312,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IRMRiskyUserProfiles +{{ Fill IRMRiskyUserProfiles Description }} + +```yaml +Type: String +Parameter Sets: ComplianceTag +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MachineLearningModelIDs This parameter is reserved for internal Microsoft use. diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md index e862d1d679..7bd53126c9 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md @@ -36,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. @@ -79,13 +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. -- 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 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 the value **Off** for the **Safe Attachments unknown malware response** policy setting in the admin center), use the value $false for the Enable parameter. +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. @@ -159,7 +159,7 @@ Accept wildcard characters: False ``` ### -MakeBuiltInProtection -The MakeBuiltInProtection switch is used for Built-in protection policy creation as part of [Preset security policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). Don't use this switch yourself. +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 @@ -181,9 +181,9 @@ The QuarantineTag parameter specifies the quarantine policy that's used on messa - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -201,7 +201,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 @@ -219,11 +219,9 @@ Accept wildcard characters: False ### -Redirect 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. +- $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) @@ -240,9 +238,7 @@ Accept wildcard characters: False ### -RedirectAddress The RedirectAddress parameter specifies the destination email address to deliver messages if malware is detected in an attachment. -The value of this parameter is meaningful only when when value of the Redirect parameter is $true and the value of the Action parameter is Allow. - -**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 diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md index f9c85d61d8..373513e1c0 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md @@ -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). @@ -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. diff --git a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md index 2afcdf6ac8..07d98d9dab 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md @@ -200,7 +200,7 @@ To enter multiple values and overwrite any existing entries, use the following s To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -For 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 @@ -313,7 +313,7 @@ Accept wildcard characters: False ``` ### -MakeBuiltInProtection -The MakeBuiltInProtection switch is used for Built-in protection policy creation as part of [Preset security policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). Don't use this switch yourself. +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 @@ -329,7 +329,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-SafeLinksRule.md b/exchange/exchange-ps/exchange/New-SafeLinksRule.md index f2edd91ac1..33a08f67c7 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/New-SafeLinksRule.md @@ -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). 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-ServicePrincipal.md b/exchange/exchange-ps/exchange/New-ServicePrincipal.md index dd24db308d..6e59edbe3e 100644 --- a/exchange/exchange-ps/exchange/New-ServicePrincipal.md +++ b/exchange/exchange-ps/exchange/New-ServicePrincipal.md @@ -33,7 +33,7 @@ New-ServicePrincipal -AppId -ObjectId ## DESCRIPTION Service principals exist in Microsoft Entra ID to define what apps can do, who can access the apps, and what resources the apps can access. In Exchange Online, service principals are references to the service principals in Microsoft Entra ID. To assign Exchange Online role-based access control (RBAC) roles to service principals in Microsoft Entra ID, you use the service principal references in Exchange Online. The **\*-ServicePrincipal** cmdlets in Exchange Online PowerShell let you view, create, and remove these service principal references. -For more information, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/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). diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md index ffaef00e8b..ed8687d950 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md @@ -26,6 +26,8 @@ New-SupervisoryReviewPolicyV2 [-Name] -Reviewers [-Confirm] [-Enabled ] [-Force] + [-PolicyRBACScopes ] + [-PreservationPeriodInDays ] [-UserReportingWorkloads ] [-WhatIf] [] @@ -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 bb6918eece..c4b9d1a57f 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` New-SupervisoryReviewRule [-Name] -Policy + [-AdvancedRule ] [-CcsiDataModelOperator ] [-Condition ] [-Confirm] @@ -39,6 +40,7 @@ New-SupervisoryReviewRule [-Name] -Policy [-IncludeAdaptiveScopes ] [-InPurviewFilter ] [-Ocr ] + [-PolicyRBACScopes ] [-SamplingRate ] [-SentTo ] [-WhatIf] @@ -100,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 }} @@ -229,7 +247,7 @@ Accept wildcard characters: False {{ Fill ExceptIfFrom Description }} ```yaml -Type: +Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -293,7 +311,7 @@ Accept wildcard characters: False {{ Fill ExceptIfSentTo Description }} ```yaml -Type: +Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -325,7 +343,7 @@ Accept wildcard characters: False {{ Fill From Description }} ```yaml -Type: +Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -385,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. @@ -405,7 +439,7 @@ Accept wildcard characters: False {{ Fill SentTo Description }} ```yaml -Type: +Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Security & Compliance diff --git a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md b/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md index 7a084db1df..18775fc30b 100644 --- a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md +++ b/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md @@ -90,9 +90,9 @@ The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy t - 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/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-policies#anatomy-of-a-quarantine-policy). +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 @@ -114,9 +114,9 @@ The MalwareQuarantineTag parameter specifies the quarantine policy that's used f - 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/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-policies#anatomy-of-a-quarantine-policy). +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 diff --git a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md index cac05b9772..b2a9f0c731 100644 --- a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md @@ -41,6 +41,9 @@ 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 diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md index 965325bbe4..6ef2975372 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -29,6 +29,7 @@ New-TenantAllowBlockListItems -Entries -ListType [-Expirat [-LogExtraDetails] [-Notes ] [-OutputJson] + [-RemoveAfter ] [-SubmissionID ] [] ``` @@ -42,6 +43,7 @@ New-TenantAllowBlockListItems -Entries -ListType [-NoExpir [-LogExtraDetails] [-Notes ] [-OutputJson] + [-RemoveAfter ] [-SubmissionID ] [] ``` @@ -70,26 +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"`. -For senders, files, and URLs the maximum number of allow entries for each type is 500, and the maximum number of block entries for each type is 500 (1000 entries total for each type). +Entry limits for each list subtype (sender, URL, file, or IP address): + +- **Exchange Online Protection**: The maximum number of allow entries is 500, and the maximum number of block entries is 500. +- **Defender for Office 365 Plan 1**: The maximum number of allow entries is 1000, and the maximum number of block entries is 1000. +- **Defender for Office 365 Plan 2**: The maximum number of allow entries is 5000, and the maximum number of block entries is 10000. The maximum number of characters in a file entry is 64 and the maximum number of characters in a URL entry is 250. -You can't mix value types (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. -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). +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[] @@ -105,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 @@ -133,6 +155,7 @@ The ListType parameter specifies the type of entry to add. Valid values are: - FileHash - Sender - Url +- IP ```yaml Type: ListType @@ -154,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 @@ -175,9 +199,9 @@ The Allow switch specifies that you're creating an allow entry. You don't need t You can't use this switch with the Block switch. -**Note**: See [Allow entries in the Tenant Allow/Block List](https://learn.microsoft.com/microsoft-365/security/office-365-security/tenant-allow-block-list-about#allow-entries-in-the-tenant-allowblock-list), before you try to create an allow entry. +**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 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). +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 @@ -213,7 +237,7 @@ Accept wildcard characters: False ### -ListSubType The ListSubType parameter specifies the subtype for this entry. Valid values are: -- AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://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 @@ -261,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. diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 2fe387e3ab..97c913ad9b 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -249,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 @@ -676,6 +676,8 @@ The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML 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. @@ -2663,11 +2665,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver -**Note**: This parameter is functional only in on-premises Exchange. This exception doesn't work in the cloud-based service. - This parameter 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. +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: @@ -3090,7 +3090,7 @@ This parameter specifies an exception or part of an exception for the rule. The 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 @@ -3270,7 +3270,7 @@ This parameter specifies an action or part of an action for the rule. 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: @@ -4030,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 @@ -4348,11 +4348,9 @@ Accept wildcard characters: False ``` ### -SCLOver -**Note**: This parameter is functional only in on-premises Exchange. This condition doesn't work in the cloud-based service. - 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. +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: @@ -4487,7 +4485,7 @@ 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, 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). +- 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. diff --git a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md index c98f768926..2196b0f833 100644 --- a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md @@ -34,7 +34,7 @@ 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/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 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/purview/microsoft-365-compliance-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/Preview-QuarantineMessage.md b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md index ae3d12cfb9..655b0da6f5 100644 --- a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md @@ -72,6 +72,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md index f73de818b3..17f3d5590b 100644 --- a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md @@ -222,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 @@ -283,6 +282,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md index 2d397247ba..47ada3944f 100644 --- a/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Remove-ATPProtectionPolicyRule.md @@ -30,7 +30,7 @@ Remove-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). diff --git a/exchange/exchange-ps/exchange/Remove-AuditConfigurationPolicy.md b/exchange/exchange-ps/exchange/Remove-AuditConfigurationPolicy.md deleted file mode 100644 index 4e88fe2c6a..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/purview/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 d8c56b2a4c..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/purview/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..559eddc8a6 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 polices 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 polices 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-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-CalendarEvents.md b/exchange/exchange-ps/exchange/Remove-CalendarEvents.md index 9b5c84ca88..c199b24fec 100644 --- a/exchange/exchange-ps/exchange/Remove-CalendarEvents.md +++ b/exchange/exchange-ps/exchange/Remove-CalendarEvents.md @@ -166,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. diff --git a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md b/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md index ed65cabff8..df3b17ddf9 100644 --- a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md @@ -13,7 +13,7 @@ ms.reviewer: ## SYNOPSIS > [!NOTE] -> Beginning in October 2022, we've disabled access to client access rules for all existing Exchange Online organizations that weren't using them. In September 2024, support for client access rules will end for all Exchange Online organizations. For more information, see [Update: Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/update-deprecation-of-client-access-rules-in-exchange-online/ba-p/3790165). +> 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. diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceTag.md b/exchange/exchange-ps/exchange/Remove-ComplianceTag.md index 0f7a5dbcf9..46c293ddf7 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceTag.md @@ -24,6 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Remove-ComplianceTag [-Identity] [-Confirm] [-ForceDeletion] + [-PriorityCleanup] [-WhatIf] [] ``` @@ -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 c85630a8a4..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 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/purview/microsoft-365-compliance-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 d807ba1009..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 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/purview/microsoft-365-compliance-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 d40591b4a1..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 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/purview/microsoft-365-compliance-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 7cf685b5b5..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 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/purview/microsoft-365-compliance-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 5f658e6b58..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 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/purview/microsoft-365-compliance-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 b6df636d3c..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 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/purview/microsoft-365-compliance-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-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-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/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 a265423f12..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/purview/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 a12fd702b9..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/purview/microsoft-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-MailUser.md b/exchange/exchange-ps/exchange/Remove-MailUser.md index 1a59beb44e..022d16da1d 100644 --- a/exchange/exchange-ps/exchange/Remove-MailUser.md +++ b/exchange/exchange-ps/exchange/Remove-MailUser.md @@ -157,7 +157,7 @@ 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. +- 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 diff --git a/exchange/exchange-ps/exchange/Remove-Mailbox.md b/exchange/exchange-ps/exchange/Remove-Mailbox.md index 38195bd6d3..27447b1e7a 100644 --- a/exchange/exchange-ps/exchange/Remove-Mailbox.md +++ b/exchange/exchange-ps/exchange/Remove-Mailbox.md @@ -109,7 +109,7 @@ In on-premises Exchange, this example removes John Rodman's mailbox from the mai ### Example 4 ```powershell -Get-Mailbox -Identity Laura -SoftDeletedMailbox | Remove-Mailbox -PermanentlyDelete. +Get-Mailbox -Identity Laura -SoftDeletedMailbox | Remove-Mailbox -PermanentlyDelete ``` In Exchange Online, this example removes the specified soft-deleted mailbox. diff --git a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md index 26031ec732..3dccb1d13c 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md @@ -189,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`. @@ -201,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-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-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-RecipientPermission.md b/exchange/exchange-ps/exchange/Remove-RecipientPermission.md index 0e5ed346d2..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,6 +165,22 @@ 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 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. diff --git a/exchange/exchange-ps/exchange/Remove-RecordLabel.md b/exchange/exchange-ps/exchange/Remove-RecordLabel.md deleted file mode 100644 index 6a2986f447..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/purview/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-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md index 750e4c23ff..586520eb81 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md @@ -24,6 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Remove-RetentionCompliancePolicy [-Identity] [-Confirm] [-ForceDeletion] + [-PriorityCleanup] [-WhatIf] [] ``` @@ -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 e800da5160..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] [] ``` @@ -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-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md index 3cccd06c8c..857607a82b 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md @@ -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). diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md index d753f857ea..e442e79efb 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md @@ -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). 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-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md index a5953f3b90..131df513a6 100644 --- a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md @@ -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 diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md index bcaa20c237..ed810f1d9c 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md @@ -32,7 +32,7 @@ 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/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 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/purview/microsoft-365-compliance-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-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md index 621b33dcb8..f6ae947e09 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md @@ -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 @@ -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,7 +83,7 @@ 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[] @@ -102,9 +103,9 @@ 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 diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md index e36c94ccea..e263889a41 100644 --- a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -15,14 +15,11 @@ ms.reviewer: ## 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). -**Note**: This cmdlet is part of a feature that's currently in a closed Private Preview. The cmdlet won't work unless your organization is a member of the Private Preview. - -Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module. Once you delete a policy, the policy is permanently deleted. You cannot undo the deletion. +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] @@ -32,15 +29,20 @@ Remove-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId ``` ## DESCRIPTION -Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module. +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 to run this cmdlet. +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). -To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/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 @@ -171,4 +173,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) -[Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids) +[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/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 62ee94e5e3..5132660f97 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -181,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 @@ -221,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 @@ -313,7 +313,7 @@ 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 required for archives and optional for primary mailboxes. A destination folder will be created if it does not exist. Valid paths are: +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` 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 d93055adcb..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 22ccc4caa3..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). @@ -129,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: @@ -254,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 4bb6315829..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. @@ -133,7 +136,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -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-UnifiedAuditLog.md b/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md index a80decad45..a6e9e07249 100644 --- a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md @@ -181,7 +181,11 @@ Accept wildcard characters: False ``` ### -HighCompleteness -{{ Fill HighCompleteness Description }} +**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 @@ -346,7 +350,7 @@ 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[] diff --git a/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md index 9f7ea7b6d5..cb0c15498e 100644 --- a/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md +++ b/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md @@ -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). diff --git a/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md index 1d1dd93d40..a2820af421 100644 --- a/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md @@ -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). diff --git a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md b/exchange/exchange-ps/exchange/Set-AcceptedDomain.md index 41140bc16f..d8069d6995 100644 --- a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md +++ b/exchange/exchange-ps/exchange/Set-AcceptedDomain.md @@ -35,6 +35,7 @@ Set-AcceptedDomain [-Identity] [-PendingCompletion ] [-PendingRemoval ] [-SendingFromDomainDisabled ] + [-SendingToDomainDisabled ] [-WhatIf] [] ``` @@ -306,7 +307,35 @@ Accept wildcard characters: False ### -SendingFromDomainDisabled This parameter is available only in the cloud-based service. -{{ Fill SendingFromDomainDisabled Description }} +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 diff --git a/exchange/exchange-ps/exchange/Set-ActivityAlert.md b/exchange/exchange-ps/exchange/Set-ActivityAlert.md deleted file mode 100644 index c310bd5b12..0000000000 --- a/exchange/exchange-ps/exchange/Set-ActivityAlert.md +++ /dev/null @@ -1,408 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://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). - -**Note**: Activity alerts have been effectively replaced by alert policies and the corresponding **\*-ProtectionAlert** cmdlets. For more information about alert policies, see [Alert policies in Microsoft 365](https://learn.microsoft.com/purview/alert-policies). - -Use the Set-ActivityAlert cmdlet to modify activity alerts. - -For 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 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/purview/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/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"`. - -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-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-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md index f78728032b..a552fa50b5 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md @@ -130,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 available only 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 @@ -170,7 +170,7 @@ 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 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: Deliver the message to quarantine. This is the default value. ```yaml @@ -432,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 @@ -479,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 @@ -588,8 +588,8 @@ The MailboxIntelligenceProtectionAction parameter specifies what to do with mess - 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 available only 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. @@ -636,9 +636,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -719,9 +719,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -764,10 +764,10 @@ This setting is part of impersonation protection and is available only in Micros 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 available only 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 @@ -792,9 +792,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -885,9 +885,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishRule.md b/exchange/exchange-ps/exchange/Set-AntiPhishRule.md index 6df8218287..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). diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md index 8138ebd112..d7b88cea53 100644 --- a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md @@ -30,6 +30,7 @@ Set-AppRetentionCompliancePolicy [-Identity] [-Applications ] [-Comment ] [-Confirm] + [-DeletedResources ] [-Enabled ] [-Force] [-PolicyRBACScopes ] @@ -49,6 +50,7 @@ Set-AppRetentionCompliancePolicy [-Identity] [-Applications ] [-Comment ] [-Confirm] + [-DeletedResources ] [-Enabled ] [-Force] [-RemoveAdaptiveScopeLocation ] @@ -56,13 +58,11 @@ Set-AppRetentionCompliancePolicy [-Identity] [] ``` -### TeamLocation +### DisableRestrictiveRetentionParameterSet ``` Set-AppRetentionCompliancePolicy [-Identity] - [-Comment ] [-Confirm] - [-Enabled ] - [-Force] + [-DeletedResources ] [-WhatIf] [] ``` @@ -71,6 +71,7 @@ Set-AppRetentionCompliancePolicy [-Identity] ``` Set-AppRetentionCompliancePolicy [-Identity] [-Confirm] + [-DeletedResources ] [-Force] [-WhatIf] [] @@ -80,28 +81,37 @@ 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 +\*-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 @@ -113,6 +123,38 @@ Set-AppRetentionCompliancePolicy -Identity "Regulation 563 Marketing" -Applicati 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 @@ -284,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. -- ExchangeLocation -- ModernGroupLocation -- AdaptiveScopeLocation +`App` is a supported value as shown in the following examples. -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:VivaEngage"`. +- **Microsoft 365 apps**: For example: + + `"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"` or `"User:MicrosoftTeams","User:VivaEngage"` + +- **Microsoft Copilot experiences**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:M365Copilot,CopilotForSecurity,CopilotinFabricPowerBI,CopilotStudio,CopilotinBusinessApplicationplatformsSales,SQLCopilot"` + + **Note**: Even though you must use `CopilotinBusinessApplicationplatformsSales` and `SQLCopilot`, those values are currently irrelevant. + +- **Enterprise AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"` + +- **Other AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:CloudAIAppChatGPTConsumer,CloudAIAppGoogleGemini,BingConsumer,DeepSeek"` ```yaml Type: String[] @@ -340,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: @@ -378,6 +462,8 @@ 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. diff --git a/exchange/exchange-ps/exchange/Set-ArcConfig.md b/exchange/exchange-ps/exchange/Set-ArcConfig.md index 63728afb45..5bf267a358 100644 --- a/exchange/exchange-ps/exchange/Set-ArcConfig.md +++ b/exchange/exchange-ps/exchange/Set-ArcConfig.md @@ -18,7 +18,6 @@ Use the Set-ArcConfig cmdlet to modify the list of trusted Authenticated Receive For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - ## SYNTAX ``` @@ -74,6 +73,27 @@ The first four commands return the existing list of ARC sealers. The first ARC s 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 @@ -100,9 +120,11 @@ The ArcTrustedSealers parameter specifies the domain name of the ARC sealers tha 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 file types that you want to keep along with the new values that you want to add. +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 add or remove file types without affecting the other file type entries, see the Examples section in this topic. +To empty the list, use the value `" "` (a space enclosed in double quotation marks). ```yaml Type: String[] diff --git a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md index 0d0202757b..397fe84e2c 100644 --- a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md +++ b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md @@ -35,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-security/safe-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). @@ -135,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-security/safe-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 diff --git a/exchange/exchange-ps/exchange/Set-AuthServer.md b/exchange/exchange-ps/exchange/Set-AuthServer.md index 8152324c61..7caef4d3c2 100644 --- a/exchange/exchange-ps/exchange/Set-AuthServer.md +++ b/exchange/exchange-ps/exchange/Set-AuthServer.md @@ -62,6 +62,19 @@ Set-AuthServer [-Identity] [] ``` +### AppSecret +``` +Set-AuthServer [-Identity] + [-ApplicationIdentifier ] + [-Confirm] + [-DomainController ] + [-DomainName ] + [-Enabled ] + [-Name ] + [-WhatIf] + [] +``` + ## DESCRIPTION Partner applications authorized by Exchange can access their resources after they're authenticated using server-to-server authentication. A partner application can authenticate by using self-issued tokens trusted by Exchange or by using an authorization server trusted by Exchange. You can use the New-AuthServer cmdlet to create a trusted authorization server object in Exchange, which allows it to trust tokens issued by the authorization server. @@ -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,7 +185,7 @@ 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. diff --git a/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md index e15813338e..3fbc56c78a 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 polices 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 polices 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 polices 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 eb00f75c05..0bfb1b4949 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md @@ -43,6 +43,7 @@ Set-AutoSensitivityLabelPolicy [-Identity] [-ExchangeSenderMemberOfException ] [-ExternalMailRightsManagementOwner ] [-Force] + [-Locations ] [-Mode ] [-OneDriveAdaptiveScopes ] [-OneDriveAdaptiveScopesException ] @@ -61,7 +62,6 @@ Set-AutoSensitivityLabelPolicy [-Identity] [-SharePointAdaptiveScopesException ] [-SpoAipIntegrationEnabled ] [-StartSimulation ] - [-SystemOperation] [-WhatIf] [] ``` @@ -243,7 +243,7 @@ Accept wildcard characters: False ``` ### -AutoEnableAfter -The AutoEnableAfter parameter allows you to automatically turn on the policy after a set time period in simulation with no modifications to the policy. You need to explictly set this parameter after each policy edit to keep or reset the automatic turn on timeline. +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. @@ -533,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: @@ -889,22 +905,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SystemOperation -{{ Fill SystemOperation Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: Identity -Aliases: -Applicable: Security & Compliance - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf The WhatIf switch doesn't work in Security & Compliance PowerShell. diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md index 6917526560..f477c1b30d 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md @@ -31,6 +31,7 @@ Set-AutoSensitivityLabelRule [-Identity] [-ContentContainsSensitiveInformation ] [-ContentExtensionMatchesWords ] [-ContentPropertyContainsWords ] + [-DefaultSpoDocLibraryHasLabel ] [-Disabled ] [-DocumentCreatedBy ] [-DocumentIsPasswordProtected ] @@ -75,6 +76,7 @@ Set-AutoSensitivityLabelRule [-Identity] [-SenderIPRanges ] [-SentTo ] [-SentToMemberOf ] + [-SourceType ] [-SubjectMatchesPatterns ] [-WhatIf] [-Workload ] @@ -236,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) @@ -283,6 +289,22 @@ 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: @@ -357,13 +379,12 @@ 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. +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,...` -- 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 length is 128 characters. The maximum number of words is 50. ```yaml Type: MultiValuedProperty @@ -1159,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 a0b40cb089..7fc266524e 100644 --- a/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md +++ b/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md @@ -36,30 +36,43 @@ 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. -{{ Fill AllowedTenantIds Description }} +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 @@ -112,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 @@ -149,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 c7a16a5f1a..6ff7e5c704 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailbox.md +++ b/exchange/exchange-ps/exchange/Set-CASMailbox.md @@ -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 ``` 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-CalendarProcessing.md b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md index c3ba75e2ba..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,6 +52,7 @@ Set-CalendarProcessing [-Identity] [-MaximumDurationInMinutes ] [-MinimumDurationInMinutes ] [-OrganizerInfo ] + [-PostReservationMaxClaimTimeInMinutes ] [-ProcessExternalMeetingMessages ] [-RemoveCanceledMeetings ] [-RemoveForwardedMeetingNotifications ] @@ -112,8 +114,29 @@ 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 @@ -123,7 +146,7 @@ Set-CalendarProcessing -Identity "Room 221" -AutomateProcessing AutoAccept -Book 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 ``` @@ -412,7 +435,11 @@ The BookInPolicy parameter specifies users or groups who are allowed to submit i Query-based groups (for example, dynamic distribution groups) aren't supported. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +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[] @@ -564,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: @@ -740,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: diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md b/exchange/exchange-ps/exchange/Set-ClientAccessRule.md index 90103f456e..9a82144d26 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Set-ClientAccessRule.md @@ -13,7 +13,7 @@ ms.reviewer: ## SYNOPSIS > [!NOTE] -> Beginning in October 2022, we've disabled access to client access rules for all existing Exchange Online organizations that weren't using them. In September 2024, support for client access rules will end for all Exchange Online organizations. For more information, see [Update: Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/update-deprecation-of-client-access-rules-in-exchange-online/ba-p/3790165). +> 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. @@ -63,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-ComplianceSearch.md b/exchange/exchange-ps/exchange/Set-ComplianceSearch.md index 5507ca50ad..fa19fdd7d3 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSearch.md @@ -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. 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 4e7012a4bd..4f490b5f0f 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md @@ -43,7 +43,7 @@ $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. @@ -54,7 +54,7 @@ $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. diff --git a/exchange/exchange-ps/exchange/Set-ComplianceTag.md b/exchange/exchange-ps/exchange/Set-ComplianceTag.md index f9e1a516b4..ef1e0e1fd7 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceTag.md @@ -20,6 +20,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX +### Default ``` Set-ComplianceTag [-Identity] [-AutoApprovalPeriod ] @@ -38,6 +39,19 @@ 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/purview/microsoft-365-compliance-center-permissions). @@ -76,7 +90,7 @@ Accept wildcard characters: False {{ Fill AutoApprovalPeriod Description }} ```yaml -Type: Object +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -285,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 3b447709c5..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-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md index a6a26aa9f8..82ecf059aa 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md @@ -36,7 +36,10 @@ To run this cmdlet, you need to be a member of one of the following directory ro - Exchange Administrator - Insights Administrator -For more information, see [Microsoft Entra built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). +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 @@ -92,7 +95,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md index 735085c40d..9c1ba06bb4 100644 --- a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -39,7 +39,10 @@ To run this cmdlet, you need to be a member of one of the following directory ro - Exchange Administrator - Insights Administrator -For more information, see [Microsoft Entra built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference). +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 diff --git a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md index cdf6574938..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 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/purview/microsoft-365-compliance-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 e86c129177..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 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/purview/microsoft-365-compliance-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-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md index b6f134b25d..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 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/purview/microsoft-365-compliance-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 526fa037db..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 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/purview/microsoft-365-compliance-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-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md index cc9d66744b..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 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/purview/microsoft-365-compliance-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 3168ad79a9..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 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/purview/microsoft-365-compliance-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 84099eadc8..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 ] [] @@ -1003,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 @@ -1115,7 +1120,10 @@ The ManagedBy parameter specifies an owner for the group. A group must have at l 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). -**Note**: 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). +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: @@ -1440,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. @@ -1647,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 3162a8ee1c..5383ebf2fa 100644 --- a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md @@ -42,6 +42,8 @@ Set-DlpCompliancePolicy [-Identity] [-Confirm] [-EndpointDlpAdaptiveScopes ] [-EndpointDlpAdaptiveScopesException ] + [-EndpointDlpExtendedLocations ] + [-EnforcementPlanes ] [-ExceptIfOneDriveSharedBy ] [-ExceptIfOneDriveSharedByMemberOf ] [-ExchangeAdaptiveScopes ] @@ -49,6 +51,8 @@ Set-DlpCompliancePolicy [-Identity] [-ExchangeSenderMemberOf ] [-ExchangeSenderMemberOfException ] [-Force] + [-IsFromSmartInsights ] + [-Locations ] [-Mode ] [-OneDriveAdaptiveScopes ] [-OneDriveAdaptiveScopesException ] @@ -74,6 +78,7 @@ Set-DlpCompliancePolicy [-Identity] [-RemoveThirdPartyAppDlpLocationException ] [-SharePointAdaptiveScopes ] [-SharePointAdaptiveScopesException ] + [-StartSimulation ] [-TeamsLocation ] [-TeamsLocationException ] [-WhatIf] @@ -550,6 +555,42 @@ 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). @@ -706,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 @@ -1094,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: `"","",...""`. @@ -1205,6 +1299,22 @@ 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 }} diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index 99c825d283..942d076ddc 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -31,6 +31,7 @@ Set-DlpComplianceRule [-Identity] [-AnyOfRecipientAddressMatchesPatterns ] [-ApplyBrandingTemplate ] [-ApplyHtmlDisclaimer ] + [-AttachmentIsNotLabeled ] [-BlockAccess ] [-BlockAccessScope ] [-Comment ] @@ -52,10 +53,12 @@ Set-DlpComplianceRule [-Identity] [-DocumentNameMatchesPatterns ] [-DocumentNameMatchesWords ] [-DocumentSizeOver ] + [-DomainCountOver ] [-EncryptRMSTemplate ] [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] [-EnforcePortalAccess ] + [-EvaluateRulePerComponent ] [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] @@ -112,8 +115,10 @@ Set-DlpComplianceRule [-Identity] [-HeaderContainsWords ] [-HeaderMatchesPatterns ] [-IncidentReportContent ] + [-MessageIsNotLabeled ] [-MessageSizeOver ] [-MessageTypeMatches ] + [-MipRestrictAccess ] [-Moderate ] [-ModifySubject ] [-NonBifurcatingAccessScope ] @@ -122,8 +127,10 @@ Set-DlpComplianceRule [-Identity] [-NotifyEmailCustomSubject ] [-NotifyEmailCustomText ] [-NotifyEmailExchangeIncludeAttachment ] + [-NotifyEmailOnedriveRemediationActions ] [-NotifyEndpointUser ] [-NotifyOverrideRequirements ] + [-NotifyPolicyTipCustomDialog ] [-NotifyPolicyTipCustomText ] [-NotifyPolicyTipCustomTextTranslations ] [-NotifyPolicyTipDisplayOption ] @@ -137,11 +144,13 @@ Set-DlpComplianceRule [-Identity] [-Quarantine ] [-RecipientADAttributeContainsWords ] [-RecipientADAttributeMatchesPatterns ] + [-RecipientCountOver ] [-RecipientDomainIs ] [-RedirectMessageTo ] [-RemoveHeader ] [-RemoveRMSTemplate ] [-ReportSeverityLevel ] + [-RestrictAccess ] [-RestrictBrowserAccess ] [-RuleErrorAction ] [-SenderADAttributeContainsWords ] @@ -159,6 +168,7 @@ Set-DlpComplianceRule [-Identity] [-SubjectOrBodyContainsWords ] [-SubjectOrBodyMatchesPatterns ] [-ThirdPartyAppDlpRestrictions ] + [-TriggerPowerAutomateFlow ] [-UnscannableDocumentExtensionIs ] [-WhatIf] [-WithImportance ] @@ -179,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", @@ -238,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")). @@ -443,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: @@ -836,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 ("). @@ -927,6 +973,34 @@ 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: @@ -2181,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. @@ -2236,6 +2326,22 @@ 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"}`. @@ -2394,6 +2500,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NotifyEmailOnedriveRemediationActions +{{ Fill NotifyEmailOnedriveRemediationActions Description }} + +```yaml +Type: NotifyEmailRemediationActions +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NotifyEndpointUser **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. @@ -2430,6 +2552,22 @@ 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. @@ -2745,6 +2883,23 @@ 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 addresses in the specified domains. You can specify multiple domains separated by commas. @@ -2841,6 +2996,22 @@ 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 }} @@ -3102,7 +3273,13 @@ Accept wildcard characters: False ``` ### -SharedByIRMUserRisk -{{ Fill SharedByIRMUserRisk Description }} +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 @@ -3234,6 +3411,22 @@ 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. 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-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md index c27087309f..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 ] [] @@ -1987,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. diff --git a/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md index 12e007c8fe..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). 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 f458a59778..3d157d6042 100644 --- a/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md @@ -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-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 93004fefc5..436392e2c0 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeSettings.md +++ b/exchange/exchange-ps/exchange/Set-ExchangeSettings.md @@ -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. 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-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md index 3381d24c29..e86f4d51b9 100644 --- a/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md @@ -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 diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md index 9d1d8185b7..64de11808a 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md @@ -169,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"`. @@ -191,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"`. @@ -213,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"`. @@ -235,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"`. @@ -261,9 +261,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -286,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/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 @@ -307,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 @@ -532,9 +532,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -557,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/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 @@ -581,9 +581,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -703,7 +703,7 @@ Accept wildcard characters: False 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 +- 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. @@ -1033,9 +1033,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -1058,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 @@ -1177,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 Junk Email folder in hybrid environments](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 @@ -1201,9 +1201,9 @@ 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 and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -1314,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 c15fe15d78..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 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). 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 e28eae6e83..76f288110e 100644 --- a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-IRMConfiguration.md @@ -372,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) diff --git a/exchange/exchange-ps/exchange/Set-InboundConnector.md b/exchange/exchange-ps/exchange/Set-InboundConnector.md index d70762f0ff..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 diff --git a/exchange/exchange-ps/exchange/Set-InboxRule.md b/exchange/exchange-ps/exchange/Set-InboxRule.md index 9f3eec447b..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. @@ -651,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. @@ -671,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. @@ -1335,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 @@ -1388,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. @@ -1408,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. diff --git a/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md index 17b465e1fb..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] [] @@ -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. diff --git a/exchange/exchange-ps/exchange/Set-Label.md b/exchange/exchange-ps/exchange/Set-Label.md index a13a632886..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,12 @@ Set-Label [-Identity] [-SiteExternalSharingControlType ] [-TeamsAllowedPresenters ] [-TeamsAllowMeetingChat ] + [-TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch ] [-TeamsBypassLobbyForDialInUsers ] + [-TeamsChannelProtectionEnabled ] + [-TeamsChannelSharedWithExternalTenants ] + [-TeamsChannelSharedWithPrivateTeamsOnly ] + [-TeamsChannelSharedWithSameLabelOnly ] [-TeamsCopyRestrictionEnforced ] [-TeamsEndToEndEncryptionEnabled ] [-TeamsLobbyBypassScope ] @@ -142,10 +149,12 @@ 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: +- **BlockContentAnalysisServices**: Specifies a privacy setting to allow or prevent content in Word, Excel, PowerPoint, and Outlook from being sent to Microsoft for content analysis. Available values are True, and False (the default). This setting impacts services such as data loss prevention policy tips, automatic and recommended labeling, and Microsoft Copilot for Microsoft 365. Example: `Set-Label -Identity Confidential -AdvancedSettings @{BlockContentAnalysisServices="True"}`. For more information, see [Prevent some connected experiences that analyze content](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#prevent-some-connected-experiences-that-analyze-content). + - **Color**: Specifies a label color as a hex triplet code for the red, green, and blue (RGB) components of the color. Example: `Set-Label -Identity 8faca7b8-8d20-48a3-8ea2-0f96310a848e -AdvancedSettings @{color="#40e0d0"}`. For more information, see [Configuring custom colors by using PowerShell](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configuring-custom-colors-by-using-powershell). - **DefaultSharingScope**: Specifies the default sharing link type for a site when the label scope includes **Groups & sites**, and the default sharing link type for a document when the label scope includes **Files & emails**. Available values are SpecificPeople, Organization, and Anyone. Example: `Set-Label -Identity General -AdvancedSettings @{DefaultSharingScope="SpecificPeople"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). @@ -279,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 @@ -412,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 @@ -445,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: @@ -590,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 @@ -682,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: @@ -878,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 @@ -1278,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: @@ -1298,6 +1371,70 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TeamsChannelProtectionEnabled +{{ Fill TeamsChannelProtectionEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithExternalTenants +{{ Fill TeamsChannelSharedWithExternalTenants Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithPrivateTeamsOnly +{{ Fill TeamsChannelSharedWithPrivateTeamsOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithSameLabelOnly +{{ Fill TeamsChannelSharedWithSameLabelOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TeamsCopyRestrictionEnforced The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: diff --git a/exchange/exchange-ps/exchange/Set-LabelPolicy.md b/exchange/exchange-ps/exchange/Set-LabelPolicy.md index 2cec29d060..5b190d2637 100644 --- a/exchange/exchange-ps/exchange/Set-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-LabelPolicy.md @@ -366,7 +366,7 @@ 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: @@ -374,6 +374,8 @@ 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"}`. +- **EnableRevokeGuiSupport**: Remove the Track & Revoke button from the sensitivity menu in Office clients. Supported apps: Word, Excel, and PowerPoint on Windows (version 2406+). Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableRevokeGuiSupport="False"}`. For more information about this configuration choice, see [Track and revoke document access](https://learn.microsoft.com/purview/track-and-revoke-admin). + - **DisableMandatoryInOutlook**: Outlook apps that support this setting exempt Outlook messages from mandatory labeling. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{DisableMandatoryInOutlook="True"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). - **OutlookDefaultLabel**: Outlook apps that support this setting apply a default label, or no label. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{OutlookDefaultLabel="None"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). diff --git a/exchange/exchange-ps/exchange/Set-MailContact.md b/exchange/exchange-ps/exchange/Set-MailContact.md index d51abf4a75..e699c9dec7 100644 --- a/exchange/exchange-ps/exchange/Set-MailContact.md +++ b/exchange/exchange-ps/exchange/Set-MailContact.md @@ -84,6 +84,8 @@ Set-MailContact [-Identity] [-UMDtmfMap ] [-UseMapiRichTextFormat ] [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] [-WhatIf] [-WindowsEmailAddress ] [] @@ -1527,6 +1529,42 @@ 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 +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-MailUser.md b/exchange/exchange-ps/exchange/Set-MailUser.md index 76f2acd687..45d451af6c 100644 --- a/exchange/exchange-ps/exchange/Set-MailUser.md +++ b/exchange/exchange-ps/exchange/Set-MailUser.md @@ -141,6 +141,7 @@ Set-MailUser [-Identity] [-EnableLitigationHoldForMigratio [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] [-LOBAppAccount] @@ -217,9 +218,10 @@ Set-MailUser [-Identity] [-ExcludeFromAllOrgHolds] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] - [-JournalArchiveAddress ] [-LOBAppAccount] + [-JournalArchiveAddress ] [-MacAttachmentFormat ] [-MailTip ] [-MailTipTranslations ] @@ -293,6 +295,7 @@ Set-MailUser [-Identity] [-ExcludeFromOrgHolds ] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] [-LOBAppAccount] @@ -369,6 +372,7 @@ Set-MailUser [-Identity] [-RecalculateInactiveMailUser] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] [-LOBAppAccount] @@ -445,6 +449,7 @@ Set-MailUser [-Identity] [-RemoveComplianceTagHoldApplied] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] [-LOBAppAccount] @@ -521,6 +526,7 @@ Set-MailUser [-Identity] [-RemoveDelayHoldApplied] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] [-LOBAppAccount] @@ -597,6 +603,7 @@ Set-MailUser [-Identity] [-RemoveDelayReleaseHoldApplied] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] [-LOBAppAccount] @@ -672,6 +679,7 @@ Set-MailUser [-Identity] [-RemoveDisabledArchive] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] [-LOBAppAccount] @@ -746,6 +754,7 @@ Set-MailUser [-Identity] [-RemoveLitigationHoldEnabled] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] [-LOBAppAccount] @@ -822,6 +831,7 @@ Set-MailUser [-Identity] [-RemoveOrphanedHolds ] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] [-LOBAppAccount] @@ -858,6 +868,81 @@ Set-MailUser [-Identity] [-RemoveOrphanedHolds ] [] ``` +### 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). @@ -1417,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 @@ -1559,7 +1644,13 @@ 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 @@ -1810,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. @@ -1858,7 +1967,7 @@ 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, Exchange Online Protection @@ -1876,7 +1985,7 @@ 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 +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: Applicable: Exchange Online, Exchange Online Protection @@ -1920,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 @@ -2092,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 @@ -2479,7 +2588,7 @@ 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 @@ -2497,7 +2606,9 @@ 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 @@ -2519,7 +2630,7 @@ 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 +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: Applicable: Exchange Online, Exchange Online Protection @@ -2776,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 4e0f11283c..f24e40f01c 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -2641,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 @@ -3507,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. @@ -3529,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. @@ -5084,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. @@ -5391,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. @@ -5492,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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md index 4d22695d70..24d0f4377e 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md @@ -278,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 @@ -428,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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md index dd21503acc..78d43a57d3 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md @@ -52,6 +52,7 @@ Set-MailboxCalendarConfiguration [-Identity] [-AgendaMailEnabled ] [-AgendaMailIntroductionEnabled ] [-AgendaPaneEnabled ] + [-AutoDeclineWhenBusy ] [-CalendarFeedsPreferredLanguage ] [-CalendarFeedsPreferredRegion ] [-CalendarFeedsRootPageId ] @@ -64,6 +65,7 @@ Set-MailboxCalendarConfiguration [-Identity] [-DefaultMinutesToReduceShortEventsBy ] [-DefaultOnlineMeetingProvider ] [-DefaultReminderTime ] + [-DeleteMeetingRequestOnRespond ] [-DiningEventsFromEmailEnabled ] [-EntertainmentEventsFromEmailEnabled ] [-EventsFromEmailEnabled ] @@ -104,6 +106,7 @@ Set-MailboxCalendarConfiguration [-MailboxLocation ] [-AgendaMailEnabled ] [-AgendaMailIntroductionEnabled ] [-AgendaPaneEnabled ] + [-AutoDeclineWhenBusy ] [-CalendarFeedsPreferredLanguage ] [-CalendarFeedsPreferredRegion ] [-CalendarFeedsRootPageId ] @@ -116,6 +119,7 @@ Set-MailboxCalendarConfiguration [-MailboxLocation ] [-DefaultMinutesToReduceShortEventsBy ] [-DefaultOnlineMeetingProvider ] [-DefaultReminderTime ] + [-DeleteMeetingRequestOnRespond ] [-DiningEventsFromEmailEnabled ] [-EntertainmentEventsFromEmailEnabled ] [-EventsFromEmailEnabled ] @@ -259,6 +263,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AutoDeclineWhenBusy +This parameter is available only in the cloud-based service. + +{{ Fill AutoDeclineWhenBusy Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CalendarFeedsPreferredLanguage This parameter is available only in the cloud-based service. @@ -478,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. @@ -516,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. @@ -703,11 +743,11 @@ Accept wildcard characters: False ### -LocationDetailsInFreeBusy This parameter is available only in the cloud-based service. -The LocationDetailsInFreeBusy parameter specifies the level of location details that are returned in user's availability. Valid values are: +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 -- Building -- Desk +- 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 @@ -717,7 +757,7 @@ Applicable: Exchange Online Required: False Position: Named -Default value: None +Default value: Desk Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md index 9f292b0326..7392f0f33e 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md @@ -29,6 +29,7 @@ Set-MailboxJunkEmailConfiguration [-Identity] [-Enabled ] [-FailOnError ] [-IgnoreDefaultScope] + [-SenderScreeningEnabled ] [-TrustedListsOnly ] [-TrustedRecipientsAndDomains ] [-TrustedSendersAndDomains ] @@ -256,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: diff --git a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md index b5b3150954..047f4af452 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md @@ -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). @@ -434,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. @@ -978,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 @@ -1143,6 +1202,42 @@ 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. diff --git a/exchange/exchange-ps/exchange/Set-MailboxSearch.md b/exchange/exchange-ps/exchange/Set-MailboxSearch.md index ea3cadc2fd..ee2ec50572 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Set-MailboxSearch.md @@ -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. @@ -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. diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md index 2643cf634c..97910b18d9 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md @@ -243,7 +243,7 @@ Accept wildcard characters: False ### -CustomExternalBody 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 meaningful only when the the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters 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 @@ -653,9 +653,9 @@ The QuarantineTag parameter specifies the quarantine policy that's used on messa - 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/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-policies#anatomy-of-a-quarantine-policy). +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`. diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md index 5ccf532b53..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). diff --git a/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md index 58de2fe175..44d3d2ad77 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md @@ -184,9 +184,9 @@ The RecipientGroupScope parameter specifies a group to consider for scoping the ```yaml Type: GroupIdParameter -Parameter Sets: RecipientGroupScope, Exchange Online Protection +Parameter Sets: RecipientGroupScope Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -267,7 +267,7 @@ 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 Microsoft Entra ID](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 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-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-MoveRequest.md b/exchange/exchange-ps/exchange/Set-MoveRequest.md index 26dc4357d6..1d1ecd41fb 100644 --- a/exchange/exchange-ps/exchange/Set-MoveRequest.md +++ b/exchange/exchange-ps/exchange/Set-MoveRequest.md @@ -45,6 +45,7 @@ Set-MoveRequest [-Identity] [-RequestExpiryInterval ] [-SkipMoving ] [-SkippedItemApprovalTime ] + [-SourceEndpoint ] [-StartAfter ] [-SuspendWhenReadyToComplete ] [-TargetDatabase ] @@ -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). @@ -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). diff --git a/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md index 8716517b81..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 Microsoft Entra ID, 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 e123223d6b..4d7ef423b7 100644 --- a/exchange/exchange-ps/exchange/Set-Notification.md +++ b/exchange/exchange-ps/exchange/Set-Notification.md @@ -14,6 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +> [!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. diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 519a2d666b..c3c3f9b530 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -23,6 +23,8 @@ For information about the parameter sets in the Syntax section below, see [Excha ### ShortenEventScopeParameter ``` Set-OrganizationConfig -ShortenEventScopeDefault + [-AcceptedDomainApprovedSendersEnabled ] + [-ActionableMessagesExtenalAccessTokenEnabled ] [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] @@ -112,7 +114,10 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-MaskClientIpInReceivedHeadersEnabled ] [-MatchSenderOrganizerProperties ] [-MessageHighlightsEnabled ] + [-MessageRecallAlertRecipientsEnabled ] + [-MessageRecallAlertRecipientsReadMessagesOnlyEnabled ] [-MessageRecallEnabled ] + [-MessageRecallMaxRecallableAge ] [-MessageRemindersEnabled ] [-MobileAppEducationEnabled ] [-OAuth2ClientProfileEnabled ] @@ -132,12 +137,14 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-ReadTrackingEnabled ] [-RecallReadMessagesEnabled ] [-RefreshSessionEnabled ] + [-RejectDirectSend ] [-RemotePublicFolderMailboxes ] [-RequiredCharsetCoverage ] [-SendFromAliasEnabled ] [-SharedDomainEmailAddressFlowEnabled ] [-SiteMailboxCreationURL ] [-SmtpActionableMessagesEnabled ] + [-TwoClickMailPreviewEnabled ] [-UnblockUnsafeSenderPromptEnabled ] [-VisibleMeetingUpdateProperties ] [-WebPushNotificationsDisabled ] @@ -149,7 +156,7 @@ Set-OrganizationConfig -ShortenEventScopeDefault ### AdfsAuthenticationParameter ``` -Set-OrganizationConfig [-AdfsAudienceUris ] [-AdfsEncryptCertificateThumbprint ] [-AdfsIssuer ] [-AdfsSignCertificateThumbprints ] +Set-OrganizationConfig [-AdfsAudienceUris ] [-AdfsEncryptCertificateThumbprint ] [-AdfsIssuer ] [-AdfsSignCertificateThumbprints ] [-ACLableSyncedObjectEnabled ] [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] @@ -206,6 +213,7 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-AdfsEncryptCe [-MicrosoftExchangeRecipientPrimarySmtpAddress ] [-MicrosoftExchangeRecipientReplyRecipient ] [-MitigationsEnabled ] + [-OabShadowDistributionOldestFileAgeLimit ] [-OAuth2ClientProfileEnabled ] [-OrganizationSummary ] [-PreferredInternetCodePageForShiftJis ] @@ -290,6 +298,7 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [-MicrosoftExchangeRecipientPrimarySmtpAddress ] [-MicrosoftExchangeRecipientReplyRecipient ] [-MitigationsEnabled ] + [-OabShadowDistributionOldestFileAgeLimit ] [-OAuth2ClientProfileEnabled ] [-OrganizationSummary ] [-PreferredInternetCodePageForShiftJis ] @@ -315,13 +324,139 @@ 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 [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] - [-BlockMoveMessagesForGroupFolders ] [-ByteEncoderTypeFor7BitCharsets ] [-Confirm] [-CustomerFeedbackEnabled ] @@ -340,8 +475,6 @@ Set-OrganizationConfig [-Force] [-HierarchicalAddressBookRoot ] [-Industry ] - [-IsGroupFoldersAndRulesEnabled ] - [-IsGroupMemberAllowedToEditContent ] [-MailTipsAllTipsEnabled ] [-MailTipsExternalRecipientsTipsEnabled ] [-MailTipsGroupMetricsEnabled ] @@ -352,6 +485,7 @@ Set-OrganizationConfig [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled ] [-MicrosoftExchangeRecipientPrimarySmtpAddress ] [-MicrosoftExchangeRecipientReplyRecipient ] + [-OabShadowDistributionOldestFileAgeLimit ] [-OrganizationSummary ] [-PermanentlyDeleteDisabled ] [-PreferredInternetCodePageForShiftJis ] @@ -366,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 @@ -442,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. @@ -460,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: @@ -635,7 +809,7 @@ The AppsForOfficeEnabled parameter specifies whether to enable apps for Outlook ```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 @@ -654,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 @@ -675,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 @@ -695,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 @@ -709,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 @@ -733,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 @@ -751,7 +928,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 @@ -765,11 +942,23 @@ Accept wildcard characters: False ### -BlockMoveMessagesForGroupFolders This parameter is available only in the cloud-based service. -{{ Fill BlockMoveMessagesForGroupFolders Description }} +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: Identity, ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online, Exchange Online Protection @@ -790,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 @@ -811,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 @@ -829,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 @@ -850,7 +1039,7 @@ The BookingsCreationOfCustomQuestionsRestricted parameter specifies whether Book ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -873,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 @@ -894,7 +1083,7 @@ The BookingsExposureOfStaffDetailsRestricted parameter specifies whether the att ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -915,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 @@ -933,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 @@ -951,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 @@ -969,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 @@ -987,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 @@ -1005,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 @@ -1026,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 @@ -1047,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 @@ -1068,7 +1257,7 @@ The BookingsPhoneNumberEntryRestricted parameter specifies whether phone numbers ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1086,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 @@ -1104,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 @@ -1125,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 @@ -1169,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 @@ -1187,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 @@ -1227,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 @@ -1248,7 +1437,7 @@ The workloads that are affected by this parameter are Outlook, SharePoint, Teams ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1273,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 @@ -1294,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 @@ -1315,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 @@ -1336,7 +1525,7 @@ The ConnectorsEnabledForYammer parameter specifies whether to enable or disable ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1372,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 @@ -1435,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 @@ -1495,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 @@ -1511,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 @@ -1539,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 @@ -1567,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 @@ -1585,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 @@ -1613,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 @@ -1624,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. @@ -1634,7 +1856,7 @@ The DirectReportsGroupAutoCreationEnabled parameter specifies whether to enable ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1657,7 +1879,7 @@ For more information about plus addressing, see [Plus addressing in Exchange Onl ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1763,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 @@ -1840,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 @@ -1879,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 @@ -1900,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 @@ -1911,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. @@ -2051,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 @@ -2069,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 @@ -2094,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 @@ -2119,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 @@ -2144,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 @@ -2169,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 @@ -2194,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 @@ -2260,7 +2507,7 @@ The HybridRSVPEnabled parameter enables or disables Hybrid RSVP for your organiz ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2310,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 @@ -2326,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 @@ -2394,11 +2641,18 @@ 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: Identity, ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online, Exchange Online Protection @@ -2412,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: Identity, ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -2440,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 @@ -2459,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 @@ -2616,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 @@ -2634,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 @@ -2668,6 +2938,42 @@ This parameter is available only in the cloud-based service. {{ Fill MessageHighlightsEnabled Description }} +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallAlertRecipientsEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageRecallAlertRecipientsEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallAlertRecipientsReadMessagesOnlyEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageRecallAlertRecipientsReadMessagesOnlyEnabled Description }} + ```yaml Type: Boolean Parameter Sets: ShortenEventScopeParameter @@ -2688,6 +2994,22 @@ This parameter is available only in the cloud-based service. ```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 @@ -2709,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 @@ -2842,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 @@ -2853,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: @@ -2865,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 @@ -2889,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 @@ -2928,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 @@ -2958,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 @@ -2976,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 @@ -2994,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 @@ -3015,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 @@ -3033,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 @@ -3074,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 @@ -3088,20 +3428,22 @@ Accept wildcard characters: False ### -PostponeRoamingSignaturesUntilLater This parameter is available only in the cloud-based service. -**Note**: This parameter is in the process of being rolled out. The rollout is expected to be completed by mid-November 2023. - 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 temporarily disabled for Outlook on the web and the new Outlook for Windows. For Windows, 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. -- $false: This is the default value. +- $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're working on API support so admins and ISVs can configure roaming signatures directly. When the new API is available (and after plenty of warning), this parameter will be deprecated. Admins will no longer need to disable roaming signatures or use the parameters on Set-MailboxMessageConfiguration to configure email signatures in Outlook on the web. +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). -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, that process is discontinued as admins can now use this parameter to disable roaming signatures themselves. +We have no plans to support roaming signature management in the Microsoft Graph API. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -3231,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 @@ -3250,7 +3592,7 @@ The PublicFolderShowClientControl parameter enables or disables the control acce ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -3302,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 @@ -3318,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 @@ -3329,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 @@ -3391,7 +3751,7 @@ For more information about the availability of the feature in Outlook on the web ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -3409,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 @@ -3425,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 @@ -3444,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 @@ -3455,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. @@ -3478,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 @@ -3541,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 @@ -3582,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 @@ -3603,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 @@ -3640,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-OutlookProvider.md b/exchange/exchange-ps/exchange/Set-OutlookProvider.md index fdb52e4cfb..3d9413c338 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookProvider.md +++ b/exchange/exchange-ps/exchange/Set-OutlookProvider.md @@ -156,7 +156,7 @@ The RequiredClientVersions parameter specifies the minimum version of Microsoft 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 fa922b0453..f159f5b833 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 ] @@ -70,6 +71,7 @@ Set-OwaMailboxPolicy [-Identity] [-GlobalAddressListEnabled ] [-GoogleDriveAttachmentsEnabled ] [-GroupCreationEnabled ] + [-HideClassicOutlookToggleOut ] [-InstantMessagingEnabled ] [-InstantMessagingType ] [-InterestingCalendarsEnabled ] @@ -83,6 +85,7 @@ Set-OwaMailboxPolicy [-Identity] [-LocalEventsEnabled ] [-LogonAndErrorLanguage ] [-MessagePreviewsDisabled ] + [-MonthlyUpdatesEnabled ] [-Name ] [-NotesEnabled ] [-NpsSurveysEnabled ] @@ -94,6 +97,10 @@ Set-OwaMailboxPolicy [-Identity] [-OrganizationEnabled ] [-OutboundCharset ] [-OutlookBetaToggleEnabled ] + [-OutlookDataFile ] + [-OutlookNewslettersAccessLevel ] + [-OutlookNewslettersReactions ] + [-OutlookNewslettersShowMore ] [-OWALightEnabled ] [-OWAMiniEnabled ] [-PersonalAccountCalendarsEnabled ] @@ -211,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: @@ -274,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 @@ -387,7 +414,7 @@ Accept wildcard characters: False ### -AllowedOrganizationAccountDomains This parameter is available only in the cloud-based service. -{{ Fill AllowedOrganizationAccountDomains Description }} +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[] @@ -602,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. + +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: -{{ Fill ChangeSettingsAccountEnabled Description }} +- $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 @@ -648,8 +680,8 @@ The ConditionalAccessPolicy parameter specifies the Outlook on the Web Policy fo 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 @@ -1223,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: @@ -1342,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 @@ -1474,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. @@ -1533,7 +1609,12 @@ Accept wildcard characters: False ### -OfflineEnabledWeb This parameter is available only in the cloud-based service. -{{ Fill OfflineEnabledWeb Description }} +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 @@ -1551,7 +1632,12 @@ Accept wildcard characters: False ### -OfflineEnabledWin This parameter is available only in the cloud-based service. -{{ Fill OfflineEnabledWin Description }} +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 @@ -1680,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 @@ -1945,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 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: @@ -2049,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-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 b402457472..aeffd3882a 100644 --- a/exchange/exchange-ps/exchange/Set-Place.md +++ b/exchange/exchange-ps/exchange/Set-Place.md @@ -32,7 +32,6 @@ Set-Place [-Identity] [-City ] [-Confirm] [-CountryOrRegion ] - [-Desks ] [-DisplayDeviceName ] [-Floor ] [-FloorLabel ] @@ -198,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 ("). diff --git a/exchange/exchange-ps/exchange/Set-PolicyConfig.md b/exchange/exchange-ps/exchange/Set-PolicyConfig.md index a9f9648e9f..6455c497f6 100644 --- a/exchange/exchange-ps/exchange/Set-PolicyConfig.md +++ b/exchange/exchange-ps/exchange/Set-PolicyConfig.md @@ -28,6 +28,7 @@ Set-PolicyConfig [[-Identity] ] [-Confirm] [-DlpAppGroups ] [-DlpAppGroupsPsws ] + [-DlpExtensionGroups ] [-DlpNetworkShareGroups ] [-DlpPrinterGroups ] [-DlpRemovableMediaGroups ] @@ -184,6 +185,22 @@ 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 }} @@ -359,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 diff --git a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md index 42bf0d589e..c1875d6ea6 100644 --- a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md @@ -391,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 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 3608ee3990..796d65b9a1 100644 --- a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md +++ b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md @@ -21,7 +21,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX ``` -Set-QuarantineTag [-Identity] +Set-QuarantinePolicy [-Identity] [-AdminNotificationFrequencyInDays ] [-AdminNotificationLanguage ] [-AdminNotificationsEnabled ] @@ -38,6 +38,7 @@ Set-QuarantineTag [-Identity] [-EsnCustomSubject ] [-ESNEnabled ] [-IgnoreDehydratedFlag] + [-IncludeMessagesFromBlockedSenderAddress ] [-MultiLanguageCustomDisclaimer ] [-MultiLanguageSenderName ] [-MultiLanguageSetting ] @@ -48,7 +49,7 @@ Set-QuarantineTag [-Identity] ``` ## DESCRIPTION -You can't modify the built-in quarantine policies named AdminOnlyAccessPolicy or DefaultFullAccessPolicy. +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). @@ -212,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 @@ -234,7 +239,7 @@ This parameter uses a decimal value that's converted from a binary value. The bi - 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: This permission is not used (the value 0 or 1 does nothing). +- PermissionToAllowSender - PermissionToBlockSender - PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one value to 1 and the other value to 0, or set both values to 0. - PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one value to 1 and the other value to 0, or set both values to 0. This permission isn't honored for messages that were quarantined as malware or high confidence phishing. If the quarantine policy gives users this permission, users are allowed to request the release of their quarantined malware or high confidence phishing messages as if PermissionToRequestRelease was selected instead. @@ -244,8 +249,8 @@ This parameter uses a decimal value that's converted from a binary value. The bi 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. @@ -343,7 +348,7 @@ To modify an existing value and preserve other values, you need to specify all e 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: +Type: MultiValuedProperty Parameter Sets: (All) Aliases: MultiValuedProperty Applicable: Exchange Online, Exchange Online Protection @@ -392,6 +397,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 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. diff --git a/exchange/exchange-ps/exchange/Set-RemoteDomain.md b/exchange/exchange-ps/exchange/Set-RemoteDomain.md index 7fa0b7cb2d..8f7c3965a5 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/Set-RemoteDomain.md @@ -534,7 +534,7 @@ Accept wildcard characters: False ### -SmtpDaneMandatoryModeEnabled This parameter is available only in the cloud-based service. -{{ Fill SmtpDaneMandatoryModeEnabled Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean diff --git a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md index ed3adf565b..9e9b525a46 100644 --- a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md @@ -300,8 +300,9 @@ The EnableReportToMicrosoft parameter specifies whether Microsoft integrated rep 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 reporting in Outlook. The following configurations are possible: @@ -322,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: 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. +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 diff --git a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md index 16e7784f81..06a61d2352 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md @@ -22,16 +22,6 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX -### RetryDistribution -``` -Set-RetentionCompliancePolicy [-Identity] [-RetryDistribution] - [-Confirm] - [-EnforceSimulationPolicy ] - [-StartSimulation ] - [-WhatIf] - [] -``` - ### Identity ``` Set-RetentionCompliancePolicy [-Identity] @@ -49,11 +39,13 @@ Set-RetentionCompliancePolicy [-Identity] [-Applications ] [-Comment ] [-Confirm] + [-DeletedResources ] [-Enabled ] [-EnforceSimulationPolicy ] [-Force] [-PolicyTemplateInfo ] [-PolicyRBACScopes ] + [-PriorityCleanup] [-RemoveExchangeLocation ] [-RemoveExchangeLocationException ] [-RemoveModernGroupLocation ] @@ -77,15 +69,29 @@ Set-RetentionCompliancePolicy [-Identity] [-AddAdaptiveScope [-Applications ] [-Comment ] [-Confirm] + [-DeletedResources ] [-Enabled ] [-EnforceSimulationPolicy ] [-Force] + [-PriorityCleanup] [-RemoveAdaptiveScopeLocation ] [-StartSimulation ] [-WhatIf] [] ``` +### RetryDistribution +``` +Set-RetentionCompliancePolicy [-Identity] [-RetryDistribution] + [-Confirm] + [-DeletedResources ] + [-EnforceSimulationPolicy ] + [-PriorityCleanup] + [-StartSimulation ] + [-WhatIf] + [] +``` + ### TeamLocation ``` Set-RetentionCompliancePolicy [-Identity] @@ -95,9 +101,11 @@ Set-RetentionCompliancePolicy [-Identity] [-AddTeamsChatLocationException ] [-Comment ] [-Confirm] + [-DeletedResources ] [-Enabled ] [-EnforceSimulationPolicy ] [-Force] + [-PriorityCleanup] [-RemoveTeamsChannelLocation ] [-RemoveTeamsChannelLocationException ] [-RemoveTeamsChatLocation ] @@ -126,6 +134,93 @@ This example makes the following changes to the existing retention policy named - 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 @@ -574,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: @@ -633,6 +754,8 @@ 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. @@ -666,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: @@ -689,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) @@ -717,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) diff --git a/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md index 9aaaf77b9c..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 ] @@ -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 @@ -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-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md index 937b6bb14e..fbaa17c621 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md @@ -34,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. @@ -44,7 +44,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Set-SafeAttachmentsPolicy -Identity "Engineering Block Attachments" -QuarantineTag ContosoLimitedAccess +Set-SafeAttachmentsPolicy -Identity "Engineering Block Attachments" -QuarantineTag ContosoLimitedAccess ``` This example modifies the existing safe attachment policy named Engineering Block Attachments to set the quarantine policy to ContosoLimitedAccess. @@ -76,13 +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. -- 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 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 the value **Off** for the **Safe Attachments unknown malware response** policy setting in the admin center), use the value $false for the Enable parameter. +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. @@ -162,9 +162,9 @@ The QuarantineTag parameter specifies the quarantine policy that's used on messa - Distinguished name (DN) - GUID -Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-end-user). +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`. @@ -184,11 +184,9 @@ Accept wildcard characters: False ### -Redirect 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. +- $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) @@ -205,9 +203,7 @@ Accept wildcard characters: False ### -RedirectAddress The RedirectAddress parameter specifies the destination email address to deliver messages if malware is detected in an attachment. -The value of this parameter is meaningful only when when value of the Redirect parameter is $true and the value of the Action parameter is Allow. - -**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 @@ -225,8 +221,6 @@ 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) diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md index aed5da770d..985e31a012 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md @@ -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). diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md index 9a2c8fe965..4587cee20b 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md @@ -194,7 +194,7 @@ 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 diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md b/exchange/exchange-ps/exchange/Set-SafeLinksRule.md index b8458c8b41..6db4b01eeb 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Set-SafeLinksRule.md @@ -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). 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-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 954024a269..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 ] @@ -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 eab1c1f939..3b3c0210d9 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md @@ -20,30 +20,9 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX -### Identity ``` Set-SupervisoryReviewRule [-Identity] - [-CcsiDataModelOperator ] - [-Condition ] - [-Confirm] - [-ContentContainsSensitiveInformation ] - [-ContentMatchesDataModel ] - [-ContentSources ] - [-ExceptIfRecipientDomainIs ] - [-ExceptIfRevieweeIs ] - [-ExceptIfSenderDomainIs ] - [-ExceptIfSubjectOrBodyContainsWords ] - [-IncludeAdaptiveScopes ] - [-InPurviewFilter ] - [-Ocr ] - [-SamplingRate ] - [-WhatIf] - [] -``` - -### Default -``` -Set-SupervisoryReviewRule + [-AdvancedRule ] [-CcsiDataModelOperator ] [-Condition ] [-Confirm] @@ -61,6 +40,7 @@ Set-SupervisoryReviewRule [-IncludeAdaptiveScopes ] [-InPurviewFilter ] [-Ocr ] + [-PolicyRBACScopes ] [-SamplingRate ] [-SentTo ] [-WhatIf] @@ -93,7 +73,7 @@ The Identity parameter specifies the supervisory review rule that you want to mo ```yaml Type: ComplianceRuleIdParameter -Parameter Sets: Identity +Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -104,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 }} @@ -218,7 +214,7 @@ Accept wildcard characters: False ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -233,8 +229,8 @@ Accept wildcard characters: False {{ Fill ExceptIfFrom Description }} ```yaml -Type: -Parameter Sets: Default +Type: MultiValuedProperty +Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -297,8 +293,8 @@ Accept wildcard characters: False {{ Fill ExceptIfSentTo Description }} ```yaml -Type: -Parameter Sets: Default +Type: MultiValuedProperty +Parameter Sets: (All) Aliases: Applicable: Security & Compliance @@ -329,7 +325,7 @@ Accept wildcard characters: False {{ Fill From Description }} ```yaml -Type: +Type: MultiValuedProperty Parameter Sets: Default Aliases: Applicable: Security & Compliance @@ -389,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. @@ -409,8 +421,8 @@ Accept wildcard characters: False {{ Fill SentTo Description }} ```yaml -Type: -Parameter Sets: Default +Type: MultiValuedProperty +Parameter Sets: (All) Aliases: Applicable: Security & Compliance 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-TeamsProtectionPolicy.md b/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md index 26c71814fc..65370a81b9 100644 --- a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md @@ -103,9 +103,9 @@ The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy t - 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/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-policies#anatomy-of-a-quarantine-policy). +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 @@ -127,9 +127,9 @@ The MalwareQuarantineTag parameter specifies the quarantine policy that's used f - 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/microsoft-365/security/office-365-security/quarantine-policies). +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/microsoft-365/security/office-365-security/quarantine-policies#anatomy-of-a-quarantine-policy). +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 diff --git a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md index 294c6c978a..859d7e7ee7 100644 --- a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md +++ b/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md @@ -32,6 +32,9 @@ Set-TeamsProtectionPolicyRule [-Identity] ``` ## 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 diff --git a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md index d32c6593f6..843a7d4d31 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md @@ -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. @@ -196,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,7 +222,7 @@ Accept wildcard characters: False ### -ListSubType The ListSubType parameter further specifies the entry that you want to modify. Valid values are: -- AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://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 @@ -264,6 +272,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RemoveAfter +The RemoveAfter parameter enables the **Remove on** \> **45 days after last used date** feature for an allow entry. The LastUsedDate property is populated when the bad entity in the allow entry is encountered by the filtering system during mail flow or time of click. The allow entry is kept for 45 days after the filtering system determines that the entity is clean. + +The only valid value for this parameter is 45. + +You can't use this parameter with the ExpirationDate or NoExpirationDate parameters. + +To change the allow entry to a static expiration date/time value that doesn't depend on the LastUsedDate property, run a Set-TenantAllowBlockListItems command with the ExpirationDate parameter. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). diff --git a/exchange/exchange-ps/exchange/Set-TransportConfig.md b/exchange/exchange-ps/exchange/Set-TransportConfig.md index 4262fd7c5c..57473281ff 100644 --- a/exchange/exchange-ps/exchange/Set-TransportConfig.md +++ b/exchange/exchange-ps/exchange/Set-TransportConfig.md @@ -62,6 +62,7 @@ Set-TransportConfig [[-Identity] ] [-MaxRetriesForRemoteSiteShadow ] [-MaxSendSize ] [-MessageExpiration ] + [-PreventDuplicateJournalingEnabled ] [-QueueDiagnosticsAggregationInterval ] [-RejectMessageOnShadowFailure ] [-ReplyAllStormBlockDurationHours ] @@ -991,6 +992,27 @@ 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. diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index af095dbd80..d5e0d7dd39 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -247,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 @@ -674,6 +674,8 @@ The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML 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. @@ -2640,11 +2642,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver -**Note**: This parameter is functional only in on-premises Exchange. This exception doesn't work in the cloud-based service. - This parameter 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. +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: @@ -3067,7 +3067,7 @@ This parameter specifies an exception or part of an exception for the rule. The 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 @@ -3247,7 +3247,7 @@ This parameter specifies an action or part of an action for the rule. 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: @@ -4023,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 @@ -4341,11 +4341,9 @@ Accept wildcard characters: False ``` ### -SCLOver -**Note**: This parameter is functional only in on-premises Exchange. This condition doesn't work in the cloud-based service. - 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. +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: diff --git a/exchange/exchange-ps/exchange/Set-TransportServer.md b/exchange/exchange-ps/exchange/Set-TransportServer.md index 00b90e63b6..f9958ab658 100644 --- a/exchange/exchange-ps/exchange/Set-TransportServer.md +++ b/exchange/exchange-ps/exchange/Set-TransportServer.md @@ -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. 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-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md index 4d7b243c0a..b54bb64a99 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md @@ -34,7 +34,7 @@ Set-UnifiedAuditLogRetentionPolicy [-Identity] -Priority [-DesiredWorkloads ] [-DisplayName ] [-DomainController ] + [-EXOModuleEnabled ] [-Fax ] [-FirstName ] [-Force] @@ -449,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. @@ -891,7 +917,7 @@ The PermanentlyClearPreviousMailboxInfo switch specifies whether to clear the Ex 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 @@ -991,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) @@ -1159,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 4384675c8e..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 Microsoft Entra ID, 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 1e8261b65d..d2c06bedea 100644 --- a/exchange/exchange-ps/exchange/Set-UserPhoto.md +++ b/exchange/exchange-ps/exchange/Set-UserPhoto.md @@ -156,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. diff --git a/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md b/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md index 962f764833..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 Microsoft Entra ID, 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 7270555558..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) diff --git a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md index 12ee6fd4a9..598f93159b 100644 --- a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md +++ b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md @@ -70,7 +70,7 @@ This example starts a new historical search named "Fabrikam Search" that has the ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". If you don't specify the time of day, the default value 0:00 AM is used. For example, the value 12/31/2022 is really "12/31/2022 0:00 AM", which means no data from 12/31/2022 is included (only data from 12/30/2022 is included). @@ -111,14 +111,16 @@ 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. +- 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. -- P2SenderAttribution: P2 Sender Attribution Report. You also need to use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. @@ -138,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 @@ -154,7 +156,7 @@ Accept wildcard characters: False ``` ### -BlockStatus -{{ Fill BlockStatus Description }} +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 @@ -186,10 +188,11 @@ Accept wildcard characters: False ``` ### -ConnectorType -The ConnectorType parameter filters the results by the connector type. Valid values are: +The ConnectorType parameter filters the results in ConnectorReport reports by the connector type. Valid values are: - OnPremises - Partner +- NoConnector ```yaml Type: String @@ -409,7 +412,7 @@ Accept wildcard characters: False ``` ### -SmtpSecurityError -{{ Fill SmtpSecurityError Description }} +The SmtpSecurityError parameter filters the results in OutboundSecurityReport reports by the error type of blocked messages when sent externally. ```yaml Type: String @@ -425,7 +428,11 @@ Accept wildcard characters: False ``` ### -TLSUsed -{{ Fill TLSUsed Description }} +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 diff --git a/exchange/exchange-ps/exchange/Start-MailboxAssistant.md b/exchange/exchange-ps/exchange/Start-MailboxAssistant.md index fcb62c4926..52a05e9bcb 100644 --- a/exchange/exchange-ps/exchange/Start-MailboxAssistant.md +++ b/exchange/exchange-ps/exchange/Start-MailboxAssistant.md @@ -137,7 +137,7 @@ Accept wildcard characters: False ``` ### -SoftDeletedMailbox -The SoftDeletedMailbox switch specifies that the mailbox to be processed by the assistant is a soft-delted mailbox. +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. diff --git a/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md b/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md index ef5bca6884..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 -The AggMailboxCleanup switch specifies a more aggressive processing cycle if items aren't moving as quickly as they should. You don't need to specify a value with this switch. +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/Test-ClientAccessRule.md b/exchange/exchange-ps/exchange/Test-ClientAccessRule.md index b500411382..3389d80031 100644 --- a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Test-ClientAccessRule.md @@ -13,7 +13,7 @@ ms.reviewer: ## SYNOPSIS > [!NOTE] -> Beginning in October 2022, we've disabled access to client access rules for all existing Exchange Online organizations that weren't using them. In September 2024, support for client access rules will end for all Exchange Online organizations. For more information, see [Update: Deprecation of Client Access Rules in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/update-deprecation-of-client-access-rules-in-exchange-online/ba-p/3790165). +> 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. diff --git a/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md b/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md index ae4250e599..d37917bd9e 100644 --- a/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md +++ b/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md @@ -258,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-TextExtraction.md b/exchange/exchange-ps/exchange/Test-TextExtraction.md index b334ac76e8..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). @@ -42,7 +44,7 @@ $content = Test-TextExtraction -FileData ([System.IO.File]::ReadAllBytes('.\fina $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 @@ -51,7 +53,7 @@ $content = Test-TextExtraction -FileData ([System.IO.File]::ReadAllBytes('.\fina 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/Update-HybridConfiguration.md b/exchange/exchange-ps/exchange/Update-HybridConfiguration.md index d8ccd53488..bb0e1ea9e9 100644 --- a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md +++ b/exchange/exchange-ps/exchange/Update-HybridConfiguration.md @@ -73,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 ] - [-Everyone ] [-Name ] [-ResultSize ] [-UserIds ] @@ -43,13 +42,13 @@ Update-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId ``` ## DESCRIPTION -Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module. +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). +- 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. @@ -60,9 +59,14 @@ 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. +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 administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). +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 @@ -89,11 +93,18 @@ This example updates who the specified policy applies to. The policy now applies ### Example 4 ```powershell -Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsFeatureEnabled $true -GroupIds group1@contoso.com -UserIds user1@contoso.com +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 @@ -191,7 +202,7 @@ Accept wildcard characters: False ``` ### -GroupIds -The GroupIds parameter specifies the email addresses of groups that the updated policy applies to. [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. +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. @@ -201,6 +212,8 @@ You can specify a maximum of 20 total users or groups (20 users and no groups, 1 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) @@ -213,7 +226,6 @@ 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: @@ -236,9 +248,9 @@ Accept wildcard characters: False ``` ### -IsUserControlEnabled -**Note**: This parameter is available in version 3.3.0 or later of the module. +**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: +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. @@ -260,6 +272,31 @@ 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 ("). @@ -351,4 +388,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) -[Role template IDs](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids) +[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 95ff54550c..bd36987193 100644 --- a/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md @@ -28,9 +28,9 @@ 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/purview/microsoft-365-compliance-center-permissions). diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index c268e93117..8ead57cb12 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -222,6 +222,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [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,8 +276,6 @@ 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) @@ -294,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) @@ -308,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) @@ -320,8 +322,6 @@ 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) @@ -344,6 +344,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [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) @@ -366,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) @@ -376,8 +378,6 @@ 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) @@ -394,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) @@ -426,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) @@ -440,8 +442,6 @@ 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) @@ -955,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) @@ -997,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) @@ -1107,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) @@ -1171,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) @@ -1298,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) @@ -1310,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) @@ -1320,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) @@ -1350,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) @@ -1618,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) @@ -1640,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) @@ -1652,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) @@ -1672,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) @@ -1719,8 +1749,6 @@ 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) @@ -1773,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) @@ -1801,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) @@ -1823,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) @@ -1868,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) @@ -1880,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) @@ -1904,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) @@ -2313,6 +2321,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ## powershell-v3-module Cmdlets ### [Add-VivaModuleFeaturePolicy](Add-VivaModuleFeaturePolicy.md) +### [Add-VivaOrgInsightsDelegatedRole](Add-VivaOrgInsightsDelegatedRole.md) + ### [Connect-ExchangeOnline](Connect-ExchangeOnline.md) ### [Connect-IPPSSession](Connect-IPPSSession.md) @@ -2355,8 +2365,12 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-VivaModuleFeaturePolicy](Get-VivaModuleFeaturePolicy.md) +### [Get-VivaOrgInsightsDelegatedRole](Get-VivaOrgInsightsDelegatedRole.md) + ### [Remove-VivaModuleFeaturePolicy](Remove-VivaModuleFeaturePolicy.md) +### [Remove-VivaOrgInsightsDelegatedRole](Remove-VivaOrgInsightsDelegatedRole.md) + ### [Set-DefaultTenantBriefingConfig](Set-DefaultTenantBriefingConfig.md) ### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md) @@ -2374,46 +2388,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-CompromisedUserDetailReport](Get-CompromisedUserDetailReport.md) -### [Get-ConnectionByClientTypeDetailReport](Get-ConnectionByClientTypeDetailReport.md) - -### [Get-ConnectionByClientTypeReport](Get-ConnectionByClientTypeReport.md) - -### [Get-CsActiveUserReport](Get-CsActiveUserReport.md) - -### [Get-CsAVConferenceTimeReport](Get-CsAVConferenceTimeReport.md) - -### [Get-CsClientDeviceDetailReport](Get-CsClientDeviceDetailReport.md) - -### [Get-CsClientDeviceReport](Get-CsClientDeviceReport.md) - -### [Get-CsConferenceReport](Get-CsConferenceReport.md) - -### [Get-CsP2PAVTimeReport](Get-CsP2PAVTimeReport.md) - -### [Get-CsP2PSessionReport](Get-CsP2PSessionReport.md) - -### [Get-CsPSTNConferenceTimeReport](Get-CsPSTNConferenceTimeReport.md) - -### [Get-CsPSTNUsageDetailReport](Get-CsPSTNUsageDetailReport.md) - -### [Get-CsUserActivitiesReport](Get-CsUserActivitiesReport.md) - -### [Get-CsUsersBlockedReport](Get-CsUsersBlockedReport.md) - -### [Get-GroupActivityReport](Get-GroupActivityReport.md) - ### [Get-HistoricalSearch](Get-HistoricalSearch.md) -### [Get-LicenseVsUsageSummaryReport](Get-LicenseVsUsageSummaryReport.md) - ### [Get-LogonStatistics](Get-LogonStatistics.md) -### [Get-MailboxActivityReport](Get-MailboxActivityReport.md) - -### [Get-MailboxUsageDetailReport](Get-MailboxUsageDetailReport.md) - -### [Get-MailboxUsageReport](Get-MailboxUsageReport.md) - ### [Get-MailDetailDlpPolicyReport](Get-MailDetailDlpPolicyReport.md) ### [Get-MailDetailEncryptionReport](Get-MailDetailEncryptionReport.md) @@ -2432,14 +2410,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [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) @@ -2450,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) diff --git a/exchange/mapping/monikerMapping.json b/exchange/mapping/MAML2Yaml/monikerMapping.json similarity index 100% rename from exchange/mapping/monikerMapping.json rename to exchange/mapping/MAML2Yaml/monikerMapping.json diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index 68aabf783a..b6691a949e 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -99,6 +99,8 @@ "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,7 +126,6 @@ "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", @@ -135,6 +135,8 @@ "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", @@ -142,13 +144,11 @@ "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", @@ -160,6 +160,8 @@ "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", @@ -171,12 +173,10 @@ "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", @@ -185,6 +185,8 @@ "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", @@ -201,14 +203,12 @@ "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", @@ -463,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", @@ -484,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", @@ -538,6 +536,7 @@ "Enable-Mailbox": "mailboxes", "Enable-ServiceEmailChannel": "mailboxes", "Enable-SweepRule": "mailboxes", + "Expedite-Delicensing": "mailboxes", "Export-MailboxDiagnosticLogs": "mailboxes", "Export-RecipientDataProperty": "mailboxes", "Get-App": "mailboxes", @@ -570,6 +569,7 @@ "Get-MailboxStatistics": "mailboxes", "Get-MailboxUserConfiguration": "mailboxes", "Get-MessageCategory": "mailboxes", + "Get-PendingDelicenseUser": "mailboxes", "Get-Place": "mailboxes", "Get-RecipientPermission": "mailboxes", "Get-RecoverableItems": "mailboxes", @@ -633,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", @@ -659,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", @@ -789,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", @@ -803,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", @@ -819,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", @@ -842,7 +857,6 @@ "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", @@ -869,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", @@ -883,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", @@ -894,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", @@ -916,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", @@ -1137,6 +1141,7 @@ "Stop-ManagedFolderAssistant": "policy-and-compliance-retention", "Validate-RetentionRuleQuery": "policy-and-compliance-retention", "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", @@ -1158,7 +1163,9 @@ "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", @@ -1167,26 +1174,8 @@ "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", @@ -1196,23 +1185,11 @@ "Get-MailTrafficPolicyReport": "reporting", "Get-MailTrafficSummaryReport": "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", 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/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-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-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/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/skype/docfx.json b/skype/docfx.json index ea84b06c31..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": [ 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-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-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 b1dbb2027a..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 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 58dcabff9d..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 @@ -118,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) 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 84fd3fdf22..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 @@ -16,8 +16,11 @@ ms.reviewer: 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 5.2.0 or later +- 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). @@ -27,13 +30,13 @@ For more information, see [Set-TeamsEnvironmentConfig](/powershell/module/teams/ ### (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 @@ -50,13 +53,13 @@ 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. @@ -113,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 @@ -159,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. @@ -192,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 @@ -461,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-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 967fccf6f2..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] [] ``` @@ -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. @@ -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. @@ -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. 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-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-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-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-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 ac9b4c4596..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 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 57f4d3125e..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 a 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 5ad7e04a7e..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 a 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-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 f1da6a8b13..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] [] ``` @@ -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 ``` @@ -215,24 +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. 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-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-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-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-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 a331921b32..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 @@ -448,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 9e433a4497..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,3345 +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-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) -The Get-CsTeamsMeetingBrandingPolicy cmdlet enables you to return information about all the meeting branding policies that have been configured for use in your organization. - +### [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-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) -Assigns a teams meeting branding policy at the per-user scope. - -### [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-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) -This cmdlet creates a new TeamsMeetingBrandingPolicy. - +### [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-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) -Deletes a previously created TeamsMeetingBrandingPolicy. - +### [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-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) -The Set-CsTeamsMeetingBrandingPolicy cmdlet allows administrators to update existing meeting branding policies. - +### [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) - -### [Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) - -### [Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) - -### [New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) - -### [Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) - -### [Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.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/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/staffhub/docfx.json b/staffhub/docfx.json deleted file mode 100644 index 3dbba278fb..0000000000 --- a/staffhub/docfx.json +++ /dev/null @@ -1,71 +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": "Standard", - "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/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/teams/Add-TeamChannelUser.md b/teams/teams-ps/teams/Add-TeamChannelUser.md index b3c8fef4de..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 --- 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 index b38def2e01..62e51c733c 100644 --- a/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Clear-TeamsEnvironmentConfig.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml Module Name: MicrosoftTeams -online version: +online version: https://learn.microsoft.com/powershell/module/teams/clear-teamsenvironmentconfig +title: Clear-TeamsEnvironmentConfig schema: 2.0.0 author: VikneshMSFT ms.author: vimohan @@ -21,7 +22,7 @@ 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. +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 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 59b1467ab6..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,61 +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 ] +[-LogLevel ] +[-LogFilePath ] [-TeamsEnvironmentName ] -[-UseDeviceAuthentication] -[-WhatIf] +[-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, GCC, GCC High, and DoD environments. +**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 @@ -80,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 ``` @@ -91,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 ``` @@ -101,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) @@ -124,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. @@ -188,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 ``` @@ -198,22 +199,22 @@ 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 Microsoft Entra 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. + 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" + 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. + 11. Add all the listed permissions. 12. Grant admin consent to both Microsoft Graph and "Skype and Teams Tenant Admin API" name. ```yaml @@ -227,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. @@ -258,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 @@ -276,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 @@ -293,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 @@ -353,7 +354,7 @@ Accept wildcard characters: False ``` ### -LogLevel -Specifies the log level. +Specifies the log level. The acceptable values for this parameter are: - Info @@ -437,7 +438,7 @@ Accept wildcard characters: False ### -TeamsEnvironmentName Specifies the Teams environment. The following environments are supported: - - Commercial or GCC environments: Don't use this parameter, this is the default. + - 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 @@ -454,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 @@ -525,8 +529,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/Disable-CsOnlineSipDomain.md b/teams/teams-ps/teams/Disable-CsOnlineSipDomain.md similarity index 90% rename from skype/skype-ps/skype/Disable-CsOnlineSipDomain.md rename to teams/teams-ps/teams/Disable-CsOnlineSipDomain.md index ada3aa5a4d..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,11 +31,11 @@ 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 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 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. @@ -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 Microsoft Entra 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 86% rename from skype/skype-ps/skype/Find-CsOnlineApplicationInstance.md rename to teams/teams-ps/teams/Find-CsOnlineApplicationInstance.md index da7369ec2a..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 +online version: https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance applicable: Microsoft Teams title: Find-CsOnlineApplicationInstance schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -155,7 +155,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 @@ -169,10 +169,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) -[New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) -[Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) +[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 d21314e0ee..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 @@ -58,5 +58,5 @@ The Get-CsCloudCallDataConnection cmdlet is only supported in commercial environ ## 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/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md similarity index 64% rename from skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md rename to teams/teams-ps/teams/Get-CsOnlineApplicationInstance.md index 970edd5fff..c153103192 100644 --- a/skype/skype-ps/skype/Get-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/teams/Get-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/get-csonlineapplicationinstance +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance applicable: Microsoft Teams title: Get-CsOnlineApplicationInstance schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -18,7 +18,7 @@ Get application instance for the tenant from Microsoft Entra ID. ## SYNTAX ``` -Get-CsOnlineApplicationInstance [[-Identity] ] [[-ResultSize] ] [[-Skip] ] [-Force] [-WhatIf] [-Confirm] [] +Get-CsOnlineApplicationInstance [[-Identity] ] [[-Identities] ] [[-ResultSize] ] [[-Skip] ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -32,15 +32,21 @@ 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 3 -------------------------- +### -------------------------- Example 4 -------------------------- ```powershell Get-CsOnlineApplicationInstance ``` @@ -50,7 +56,23 @@ 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 is not provided, it will retrieve all application instances in the tenant. +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 @@ -147,7 +169,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,10 +179,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) -[New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) -[Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) +[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 84% rename from skype/skype-ps/skype/Get-CsOnlineLisCivicAddress.md rename to teams/teams-ps/teams/Get-CsOnlineLisCivicAddress.md index f75be6024d..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 @@ -174,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 @@ -190,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 @@ -206,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 @@ -222,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 @@ -239,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 @@ -258,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 ca2b81ecf8..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: --- @@ -315,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 62% rename from skype/skype-ps/skype/Get-CsOnlineSchedule.md rename to teams/teams-ps/teams/Get-CsOnlineSchedule.md index 1e1def474d..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 [-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 @@ -59,7 +59,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -70,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 e46d6d12b1..e2731e0eed 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md +++ b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberCountry.md @@ -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 e93fa599dd..47c397e14b 100644 --- a/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md +++ b/teams/teams-ps/teams/Get-CsOnlineTelephoneNumberType.md @@ -25,7 +25,6 @@ Get-CsOnlineTelephoneNumberType [-Country] [] 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 ### -------------------------- Example 1 -------------------------- @@ -74,7 +73,6 @@ AutoAttendantTollFree ``` This example returns the list of supported NumberTypes in Canada. - ## PARAMETERS ### Country @@ -83,7 +81,7 @@ Specifies the country or region that the number offerings belong. The country co ```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/skype/skype-ps/skype/Get-CsOnlineUser.md b/teams/teams-ps/teams/Get-CsOnlineUser.md similarity index 54% rename from skype/skype-ps/skype/Get-CsOnlineUser.md rename to teams/teams-ps/teams/Get-CsOnlineUser.md index 6ea1c1b8da..4a4e832276 100644 --- a/skype/skype-ps/skype/Get-CsOnlineUser.md +++ b/teams/teams-ps/teams/Get-CsOnlineUser.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-csonlineuser -applicable: Microsoft Teams, Skype for Business Online +online version: https://learn.microsoft.com/powershell/module/teams/get-csonlineuser +applicable: Microsoft Teams title: Get-CsOnlineUser schema: 2.0.0 -manager: bulenteg -author: isrumnon -ms.author: isrumnon +manager: sshastri +author: praspatil +ms.author: praspatil ms.reviewer: --- @@ -20,30 +20,24 @@ Returns information about users who have accounts homed on Microsoft Teams or Sk ``` Get-CsOnlineUser [[-Identity] ] [-AccountType ] - [-Credential ] - [-DomainController ] [-Filter ] - [-LdapFilter ] - [-OnModernServer] - [-OnOfficeCommunicationServer] - [-OU ] + [-Properties ] [-ResultSize ] [-SkipUserPolicies] + [-SoftDeletedUser] [-Sort] - [-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. +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 you can return users from a specified tenant by using the Filter parameter and a command similar to this: +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'"` @@ -126,14 +120,14 @@ This parameter is added to Get-CsOnlineUser starting from TPM 4.5.1 to indicate - `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. +- `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, Skype for Business Online +applicable: Microsoft Teams Required: False Position: 1 @@ -164,7 +158,7 @@ Using the Teams PowerShell Module version 2.6 or earlier only, you can use the f Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: 1 @@ -173,214 +167,22 @@ 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"``. -**Updates in Teams PowerShell Module version 5.0.0 and later** - -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 or later (note that these changes are only rolled out in commercial environments at present). These updates will be applicable to remaining Teams PowerShell versions by 15th April 2023: - -_Performance_ - -The performance of Get-CsOnlineUser without the "-identity" parameter is improved. Here are some examples where significant improvement can be observed: - +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"} -_New Filtering Attributes_ - -These attributes are now enabled for filtering: - -- Alias -- City -- Company -- HostingProvider -- UserValidationErrors -- OnPremEnterpriseVoiceEnabled -- OnPremHostingProvider -- OnPremLineURI -- OnPremSIPEnabled -- SipAddress -- SoftDeletionTimestamp -- StateOrProvince -- Street -- TeamsOwnersPolicy -- WhenChanged -- WhenCreated -- FeatureTypes -- PreferredDataLocation -- LastName - -_New Operators_ - -These filtering operators have been reintroduced: - -`-like` operator now supports the use of wildcard operators in 'contains' and 'ends with' scenarios. For example: - -- Contains Scenario: Get-CsOnlineUser -Filter "DisplayName -like '*abc*'" -- Ends with scenario: Get-CsOnlineUser -Filter {DisplayName -like '*abc'} - -`-contains` can now be used to filter properties that are an array of strings like FeatureTypes, ProxyAddresses, and ShadowProxyAddresses. For example: - -- Get-CsOnlineUser -Filter {FeatureTypes -contains "PhoneSystem"} -- Get-CsOnlineUser -Filter {ProxyAddresses -contains "SMTP:abc@xyz.com"} - - -`-gt` (greater than), `-lt` (less than), and `-le` (less than or equal to) can now be used for filtering all string properties. For example: - -- Get-CsOnlineUser -Filter {UserPrincipalName -gt/-le/-lt "abc"} - -`-ge` (greater than or equal to) can now also be used for filtering on policies. For example: - -- Get-CsOnlineUser -Filter {ExternalAccessPolicy -ge "xyz_policy"} - -**Note**: Some comparison operators mentioned above including -ge, -le, -gt, and -lt are case-sensitive for Policies and capital letters are considered smaller than small letters. - - -**Updates in Teams PowerShell Module version 3.0.0 and later** - -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 and later): - -In the Teams PowerShell Module version 3.0.0 or later, filtering functionality is now limited to the following attributes: - -- 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 +applicable: Microsoft Teams Required: False Position: Named @@ -389,18 +191,19 @@ 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. +### -Properties -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. +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. -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"`. +Examples: +- Get-CsOnlineUser -Properties DisplayName, UserPrincipalName, FeatureTypes +- Get-CsOnlineUser -Properties DisplayName, Alias, LineURI ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -409,32 +212,19 @@ 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. +### -ResultSize -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: OnLyncServer -Applicable: Microsoft Teams, Skype for Business Online +**Note**: Starting with Teams PowerShell Modules version 4.0 and later, "-ResultSize" type has been changed to uint32. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +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. -### -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. +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: SwitchParameter +Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -443,14 +233,14 @@ 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. +### -SkipUserPolicies +PARAMVALUE: SwitchParameter ```yaml -Type: OUIdParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -459,35 +249,15 @@ 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 -``` +### -SoftDeletedUser -### -SkipUserPolicies -PARAMVALUE: SwitchParameter +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, Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -498,15 +268,17 @@ Accept wildcard characters: False ### -Sort -Sorting is now enabled in Teams PowerShell Module 5.1.0 and later by using the "-Sort" or "-OrderBy" parameters. This parameter is currently rolled out in commercial environments only. For example: +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: +Aliases: OrderBy Applicable: Microsoft Teams Required: False @@ -516,75 +288,131 @@ 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. +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). -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. +## INPUTS -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +## OUTPUTS -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +## NOTES -### -UsePreferredDC +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. -Reserved for Microsoft internal use. +**Commonly used FeatureTypes and their descriptions:** -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: +- 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. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +**Updates in Teams PowerShell Module version 7.0.0 and later**: -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +- 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. -## OUTPUTS +**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'} -### Notes +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 5.0.0 and later** +**Updates in Teams PowerShell Module version 6.1.0 and later**: -The following updates are applicable for organizations having TeamsOnly users that use Microsoft Teams PowerShell version 5.0.0 and later (note that these changes are only rolled out in commercial environments at present). These updates will be applicable to remaining Teams PowerShell versions by 15th April 2023: +The following updates are applicable for organizations that use Microsoft Teams PowerShell version 6.1.0 or later. -New attributes have now been introduced in the output of Get-CsOnlineUser when not using the "-identity" parameter: +- 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 -- SipProxyAddress -- TeamsMediaLoggingPolicy - UserValidationErrors - WhenCreated -The following updates are now applicable to the output in scenarios where "-identity" parameter is not used: +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 users are now available in the output. -- Unlicensed Users: Unlicensed users would show up in the output for 30 days post-license removal. +- 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 users and SoftDeletedUsers are not required in the output then they can be filtered out by using filter on AccountType and SoftDeletionTimestamp respectively. For example: +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** +**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: @@ -747,10 +575,6 @@ In Teams PowerShell Modules 3.0.0 and above OnPremLineURI will only refer to the - **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 - ## RELATED LINKS -[Set-CsUser](Set-CsUser.md) +[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 90% rename from skype/skype-ps/skype/Get-CsOnlineVoiceUser.md rename to teams/teams-ps/teams/Get-CsOnlineVoiceUser.md index 9b84141e63..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: --- @@ -55,7 +55,7 @@ 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 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: +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). @@ -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 @@ -203,8 +202,8 @@ 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 e2a2e426c1..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 @@ -20,21 +21,39 @@ This cmdlet displays information about one or more phone numbers. ### Assignment (Default) ```powershell Get-CsPhoneNumberAssignment [-ActivationState ] [-AssignedPstnTargetId ] [-AssignmentCategory ] - [-CapabilitiesContain ] [-CivicAddressId ] [-IsoCountryCode ] + [-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. - +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 @@ -57,11 +76,12 @@ IsoSubdivision : Nebraska LocationId : 407c17ae-8c41-431e-894a-38787c682f68 LocationUpdateSupported : True NetworkSiteId : -PortInOrderStatus : +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. @@ -77,18 +97,19 @@ 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 NetworkSiteId : -PortInOrderStatus : +PortInOrderStatus : PstnAssignmentStatus : UserAssigned -PstnPartnerId : +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. @@ -124,27 +145,99 @@ This example returns information about all phone numbers that contain the digits ### Example 8 ```powershell -(Get-CsPhoneNumberAssignment | Where-Object {$_.NumberType.Contains('CallingPlan') -and $_.Capability.Contains('UserAssignment') -and ($_.PstnAssignmentStatus.Contains('UserAssigned') -or $_.PstnAssignmentStatus.Contains('Unassigned'))}).Count +Get-CsPhoneNumberAssignment -Skip 1000 -Top 1000 ``` -This example returns the number of Calling Plan subscriber phone numbers that are either assigned or not assigned to users. +This example returns all phone numbers sequenced between 1001 to 2000 in the record of phone numbers. ### Example 9 ```powershell -(Get-CsPhoneNumberAssignment | Where-Object {!$_.NumberType.Contains('DirectRouting') -and $_.Capability.Contains('VoiceApplicationAssignment') -and $_.Capability.Contains('ConferenceAssignment')}).Count +Get-CsPhoneNumberAssignment -AssignedPstnTargetId 'TeamsSharedCallingRoutingPolicy|Tag:SC1' ``` -This example returns the number of Calling Plan or Operator Connect service phone numbers that can be assigned to voice applications and conference bridges. +This example returns all phone numbers assigned as emergency numbers in the Teams shared calling routing policy instance SC1. ### Example 10 ```powershell -Get-CsPhoneNumberAssignment -Top ([int]::MaxValue) +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 returns all phone numbers. +This example displays when SkipInternalVoip option is turned on for a number. ### Example 11 ```powershell -Get-CsPhoneNumberAssignment -AssignedPstnTargetId 'TeamsSharedCallingRoutingPolicy|Tag:SC1' +Get-CsPhoneNumberAssignment -Filter "TelephoneNumber -eq '+12065551000'" ``` -This example returns all phone numbers assigned as emergency numbers in the Teams shared calling routing policy instance SC1. +```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 @@ -155,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 @@ -167,11 +260,10 @@ 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, ObjectId, and the Teams shared calling routing policy instance name. - ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -181,12 +273,12 @@ Accept wildcard characters: False ``` ### -AssignmentCategory -This parameter is reserved for internal Microsoft use. +This parameter is used to differentiate between Primary and Private line assignment for a user. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -198,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 @@ -215,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 @@ -229,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 @@ -245,12 +352,12 @@ 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 @@ -265,7 +372,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -280,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 @@ -295,7 +402,7 @@ Filters the returned results based on the assignment status. Support values are ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -319,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 @@ -342,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 @@ -358,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 @@ -374,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 @@ -389,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 @@ -404,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 @@ -458,7 +565,6 @@ 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. @@ -482,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 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 a8c57fd3dc..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, Teams users over voice, video and screen sharing, 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 81% rename from skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md index 77039370d9..cc36983ff2 100644 --- a/skype/skype-ps/skype/Get-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsAppPermissionPolicy.md @@ -1,165 +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 - -```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 +--- +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 95% rename from skype/skype-ps/skype/Get-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsAppSetupPolicy.md index 847b078707..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 @@ -46,7 +47,7 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ```powershell Get-CsTeamsAppSetupPolicy -Identity Global ``` - + ```Output Identity : Global AppPresetList : {Id=d2c6f111-ffad-42a0-b65e-ee00425598aa} @@ -149,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 83% rename from skype/skype-ps/skype/Get-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md index 6976a40438..479035c0ea 100644 --- a/skype/skype-ps/skype/Get-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsCallHoldPolicy.md @@ -1,127 +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: jenstr -author: jenstrier ---- - -# 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](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 4ad4975e14..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-msft -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 index d3815393f0..963877780a 100644 --- a/teams/teams-ps/teams/Get-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/teams/Get-CsTeamsCustomBannerText.md @@ -1,18 +1,17 @@ --- 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 -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsCustomBannerText -schema: 2.0.0 --- - # Get-CsTeamsCustomBannerText ## SYNOPSIS -Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. ## SYNTAX @@ -25,7 +24,6 @@ Get-CsTeamsCustomBannerText [[-Identity] ] [] Returns all or a single instance of custom banner text. - ## EXAMPLES ### Example 1 @@ -62,7 +60,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 @@ -70,12 +67,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) -[New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) -[Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) +[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 76% rename from skype/skype-ps/skype/Get-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsEmergencyCallingPolicy.md index 7e4bf7e111..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 @@ -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,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 index a23a75b3fb..274a3a8171 100644 --- a/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration.md @@ -1,11 +1,11 @@ --- 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 -online version: https://learn.microsoft.com/powershell/module/teams/Get-CsTeamsFirstPartyMeetingTemplateConfiguration -schema: 2.0.0 --- # Get-CsTeamsFirstPartyMeetingTemplateConfiguration @@ -29,17 +29,14 @@ This is a read-only configuration. ### Example 1 - Fetching all first party meeting templates on the tenant ```powershell -Get-CsTeamsFirstPartyMeetingTemplateConfiguration -``` +PS C:\> Get-CsTeamsFirstPartyMeetingTemplateConfiguration -```output 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 @@ -77,5 +74,11 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +## OUTPUTS + +## NOTES + ## RELATED LINKS -[Get-CsTeamsMeetingTemplateConfiguration](Get-CsTeamsMeetingTemplateConfiguration.yml) +[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/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md similarity index 77% rename from skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md index 1ab132b634..d7a61ce63f 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingBrandingPolicy.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsmeetingbrandingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Get-CsTeamsMeetingBrandingPolicy -author: szymonkatraMSFT -ms.author: szymonkatra +author: serdarsoysal +ms.author: serdars ms.reviewer: manager: stanlythomas --- @@ -15,7 +15,6 @@ manager: stanlythomas ## SYNOPSIS The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control the appearance in meetings by defining custom backgrounds, logos, and colors. - ## SYNTAX ### Identity (Default) @@ -82,6 +81,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). +## INPUTS + ## OUTPUTS ### TeamsMeetingBrandingPolicy.Cmdlets.TeamsMeetingBrandingPolicy @@ -92,12 +93,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file +[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 index 7fed1ca453..f5121f5202 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplateConfiguration.md @@ -27,10 +27,8 @@ Fetches the list of custom templates on the tenant. Each template object contain ### Example 1 - Fetching all custom meeting templates on the tenant ```powershell -Get-CsTeamsMeetingTemplateConfiguration -``` +PS C:\> Get-CsTeamsMeetingTemplateConfiguration -```output Identity : Global TeamsMeetingTemplates : {default, customtemplate_1cb7073a-8b19-4b5d-a3a6-14737d006969, customtemplate_21ecf22c-eb1a-4f05-93e0-555b994ebeb5, @@ -74,6 +72,11 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +## OUTPUTS + +## NOTES ## RELATED LINKS -[Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.yml) +[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 index 0ee47f45be..22af122659 100644 --- a/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsMeetingTemplatePermissionPolicy.md @@ -17,12 +17,12 @@ Fetches the TeamsMeetingTemplatePermissionPolicy. This policy can be used to hid ### Identity ```powershell -Get-CsTeamsMeetingTemplatePermissionPolicy [[-Identity] ] [] +Get-CsTeamsMeetingTemplatePermissionPolicy [[-Identity] ] [] ``` ### Filter ```powershell -Get-CsTeamsMeetingTemplatePermissionPolicy [-Filter ] [] +Get-CsTeamsMeetingTemplatePermissionPolicy [-Filter ] [] ``` ## DESCRIPTION @@ -33,9 +33,8 @@ Fetches the instances of the policy. Each policy object contains a property call ### Example 1 - Fetching all policies ```powershell -Get-CsTeamsMeetingTemplatePermissionPolicy -``` -```output +PS C:\> Get-CsTeamsMeetingTemplatePermissionPolicy + Identity : Global HiddenMeetingTemplates : {} Description : @@ -58,9 +57,8 @@ Fetches all the policy instances currently available. ### Example 2 - Fetching a specific policy using its identity ```powershell -PS> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar -``` -```output +PS C:\> Get-CsTeamsMeetingTemplatePermissionPolicy -Identity Foobar + Identity : Tag:Foobar HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} Description : @@ -71,9 +69,8 @@ Fetches an instance of a policy with known identity. ### Example 3 - Fetching policies using regex ```powershell -PS> Get-CsTeamsMeetingTemplatePermissionPolicy -Filter *Foo* -``` -```output +PS C:\> Get-CsTeamsMeetingTemplatePermissionPolicy -Filter *Foo* + Identity : Tag:Foobar HiddenMeetingTemplates : {customtemplate_9ab0014a-bba4-4ad6-b816-0b42104b5056} Description : @@ -120,11 +117,17 @@ 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](Set-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.yml) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) -[Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) -[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.yml) \ No newline at end of file +[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 index eb17302988..817189ce6e 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsSharedCallingRoutingPolicy.md @@ -3,11 +3,12 @@ external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Get-CsTeamsSharedCallingRoutingPolicy schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Get-CsTeamsSharedCallingRoutingPolicy @@ -61,7 +62,7 @@ The command shown in Example 4 returns information about the Global policy insta ## PARAMETERS ### -Identity -Unique identifier of the Teams shared calling routing policy to be retrieved. +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. @@ -104,10 +105,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Set-CsTeamsSharedCallingRoutingPolicy](Set-CsTeamsSharedCallingRoutingPolicy.md) +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) -[Grant-CsTeamsSharedCallingRoutingPolicy](Grant-CsTeamsSharedCallingRoutingPolicy.md) +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) -[Remove-CsTeamsSharedCallingRoutingPolicy](Remove-CsTeamsSharedCallingRoutingPolicy.md) +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) -[New-CsTeamsSharedCallingRoutingPolicy](New-CsTeamsSharedCallingRoutingPolicy.md) +[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 index f7ae86fa76..5bfed6ecbd 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnection.md @@ -2,8 +2,8 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: Get-CsTeamsShiftsConnection -author: shane-malone -ms.author: shanemalone +author: serdarsoysal +ms.author: serdars manager: valk online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection schema: 2.0.0 @@ -17,17 +17,17 @@ This cmdlet returns the list of existing workforce management (WFM) connections. ## 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] [] ``` @@ -81,7 +81,6 @@ State : Active TenantId : dfd24b34-ccb0-47e1-bdb7-000000000000 ``` - Returns the list of connections. ### Example 2 @@ -108,7 +107,6 @@ PS C:\> $connection.ToJsonString() ``` Returns the connection with the specified -ConnectionId. - ## PARAMETERS ### -Break @@ -231,6 +229,21 @@ 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). @@ -248,8 +261,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) -[Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) +[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 feb5b1abc9..b236e9c29c 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionConnector.md @@ -60,10 +60,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) -[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) -[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) +[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 7fe182b94d..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 ] [-After ] [-Before ] [-Code ] [-ConnectionId ] [-ConnectorInstanceId ] [-Operation ] [-Procedure ] [-TeamId ] [] +### 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 @@ -289,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). @@ -300,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 b160e7fb3b..9cae80f516 100644 --- a/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Get-CsTeamsShiftsConnectionInstance.md @@ -96,7 +96,6 @@ TenantId : dfd24b34-ccb0-47e1-bdb7-e49db9c7c14a WorkforceIntegrationId : WFI_6b225907-b476-4d40-9773-08b86db7b11b ``` - Returns the list of connection instances. ### Example 2 @@ -134,7 +133,6 @@ PS C:\> $ci.ToJsonString() ``` Returns the connection instance with the specified -ConnectorInstanceId. - ## PARAMETERS ### -Break @@ -274,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 36d9987a55..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,6 +90,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[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 1145fdfc15..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] [] +``` + +### Get1 +```powershell +Get-CsTeamsShiftsConnectionWfmTeam -ConnectionId [-Authorization ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +``` + +### GetViaIdentity1 +```powershell +Get-CsTeamsShiftsConnectionWfmTeam -InputObject [-Authorization ] + [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] ``` -Get-CsTeamsShiftsConnectionWfmTeam -ConnectionId -ConnectorInstanceId [] + +### GetViaIdentity +```powershell +Get-CsTeamsShiftsConnectionWfmTeam -InputObject [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] ``` ## DESCRIPTION @@ -85,7 +109,7 @@ Returns the WFM teams for the WFM connection with ID `a2d1b091-5140-4dd2-987a-98 ### -ConnectorInstanceId -The ID of the connection instance. You can retrieve 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 @@ -101,7 +125,7 @@ Accept wildcard characters: False ### -ConnectionId -The ID of the connection. You can retrieve it by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). +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 @@ -115,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). @@ -126,8 +270,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) -[Get-CsTeamsShiftsConnectionInstance](Get-CsTeamsShiftsConnectionInstance.md) +[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 6757602c72..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 --- @@ -14,15 +15,18 @@ This cmdlet allows you to get properties of a TeamsShiftPolicy instance, includi ## SYNTAX ### Identity (Default) -``` +```powershell Get-CsTeamsShiftsPolicy [[-Identity] ] [] ``` +### 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 ### Example 1 @@ -56,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 @@ -67,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 index 886e104d9e..bae35132f4 100644 --- a/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTeamsSipDevicesConfiguration.md @@ -17,28 +17,37 @@ This cmdlet is used to retrieve the organization-wide Teams SIP devices configur ## SYNTAX ```powershell -Get-CsTeamsSipDevicesConfiguration +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 Administrator, Global Reader, Teams Administrator, or Teams Communication Administrator. +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 -Get-CsTeamsSipDevicesConfiguration -``` -```Output +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](Set-CsTeamsSipDevicesConfiguration.md) +[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 index 414d5e0a0b..783c5f16c2 100644 --- a/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsTemplatePermissionPolicy.md @@ -5,7 +5,7 @@ online version: https://learn.microsoft.com/powershell/module/teams/get-csteamst title: Get-CsTeamsTemplatePermissionPolicy author: yishuaihuang4 ms.author: yishuaihuang -ms.reviewer: +ms.reviewer: manager: weiliu2 schema: 2.0.0 --- @@ -119,8 +119,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) -[Remove-CsTeamsTemplatePermissionPolicy](Remove-CsTeamsTemplatePermissionPolicy.md) +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) -[Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) +[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 index a54c21d6cb..5d698766b8 100644 --- a/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/teams/Get-CsTeamsVirtualAppointmentsPolicy.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsvirtualappointmentspolicy +online version: https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy +title: Get-CsTeamsVirtualAppointmentsPolicy schema: 2.0.0 ms.author: erocha manager: sonaggarwal @@ -35,8 +36,8 @@ Fetches instances of TeamsVirtualAppointmentsPolicy. Each policy object contains PS C:\> Get-CsTeamsVirtualAppointmentsPolicy ``` ```output -Identity EnableSmsNotifications --------- ---------------------- +Identity EnableSmsNotifications +-------- ---------------------- Global True Tag:sms-enabled True Tag:sms-disabled False @@ -48,8 +49,8 @@ Fetches all the policy instances currently available. PS C:\> Get-CsTeamsVirtualAppointmentsPolicy -Identity sms-enabled ``` ```output -Identity EnableSmsNotifications --------- ---------------------- +Identity EnableSmsNotifications +-------- ---------------------- Tag:sms-enabled True ``` Fetches an instance of a policy with a known identity. @@ -59,8 +60,8 @@ Fetches an instance of a policy with a known identity. PS C:\> Get-CsTeamsVirtualAppointmentsPolicy -Filter *sms* ``` ```output -Identity EnableSmsNotifications --------- ---------------------- +Identity EnableSmsNotifications +-------- ---------------------- Tag:sms-enabled True Tag:sms-disabled False ``` @@ -114,10 +115,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md) +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) -[Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md) +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) -[Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md) +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) -[Grant-CsTeamsVirtualAppointmentsPolicy](Grant-CsTeamsVirtualAppointmentsPolicy.md) +[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 80% rename from skype/skype-ps/skype/Get-CsTenantDialPlan.md rename to teams/teams-ps/teams/Get-CsTenantDialPlan.md index 7b89439c39..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 +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: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -59,7 +59,7 @@ The Filter parameter allows you to limit the number of results based on filters ```yaml Type: String Parameter Sets: (Filter) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -75,7 +75,7 @@ The Identity parameter is a unique identifier that designates the name of the te ```yaml Type: String Parameter Sets: (Identity) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -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 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) -[New-CsTenantDialPlan](New-CsTenantDialPlan.md) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) -[Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) -[Remove-CsTenantDialPlan](Remove-CsTenantDialPlan.md) +[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 86% rename from skype/skype-ps/skype/Get-CsTenantLicensingConfiguration.md rename to teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.md index e284c75f1e..5eab013035 100644 --- a/skype/skype-ps/skype/Get-CsTenantLicensingConfiguration.md +++ b/teams/teams-ps/teams/Get-CsTenantLicensingConfiguration.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-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 @@ -47,7 +47,6 @@ Get-CsTenantLicensingConfiguration The command shown in Example 1 returns licensing configuration information for the current tenant: - ## PARAMETERS ### -Filter @@ -57,8 +56,8 @@ Because each tenant is limited to a single, global collection of licensing confi ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -74,8 +73,8 @@ Because each tenant is limited to a single, global collection of licensing setti ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: 2 @@ -100,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 82% rename from skype/skype-ps/skype/Get-CsTenantNetworkRegion.md rename to teams/teams-ps/teams/Get-CsTenantNetworkRegion.md index ed7aa91aec..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 +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion applicable: Microsoft Teams title: Get-CsTenantNetworkRegion schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -28,11 +28,11 @@ 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 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 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. @@ -45,7 +45,7 @@ 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 ``` @@ -85,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 @@ -95,11 +94,12 @@ For more information, see [about_CommonParameters ](https://go.microsoft.com/fwl ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[New-CsTenantNetworkRegion](New-CsTenantNetworkRegion.md) +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) -[Remove-CsTenantNetworkRegion](Remove-CsTenantNetworkRegion.md) +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) -[Set-CsTenantNetworkRegion](Set-CsTenantNetworkRegion.md) +[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 88% rename from skype/skype-ps/skype/Get-CsTenantNetworkSite.md rename to teams/teams-ps/teams/Get-CsTenantNetworkSite.md index 3d7db736d4..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 +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite applicable: Microsoft Teams title: Get-CsTenantNetworkSite schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -37,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. @@ -108,8 +108,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -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,7 +126,7 @@ The description of the site. The network region ID of the site. ### LocationPolicyID -The ID of the locaton policy assigned to the site. +The ID of the location policy assigned to the site. ### SiteAddress This parameter is reserved for internal Microsoft use. @@ -166,8 +165,8 @@ This parameter is reserved for internal Microsoft use. The parameter IncludePhoneNumbers was introduced in Teams PowerShell Module 5.5.0. ## RELATED LINKS -[New-CsTenantNetworkSite](New-CsTenantNetworkSite.md) +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) -[Remove-CsTenantNetworkSite](Remove-CsTenantNetworkSite.md) +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) -[Set-CsTenantNetworkSite](Set-CsTenantNetworkSite.md) +[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 84% rename from skype/skype-ps/skype/Get-CsTenantNetworkSubnet.md rename to teams/teams-ps/teams/Get-CsTenantNetworkSubnet.md index e00ae09d5c..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 +online version: https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet applicable: Microsoft Teams title: Get-CsTenantNetworkSubnet schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -32,7 +32,7 @@ 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. @@ -85,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 @@ -98,8 +97,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## RELATED LINKS -[New-CsTenantNetworkSubnet](New-CsTenantNetworkSubnet.md) +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) -[Remove-CsTenantNetworkSubnet](Remove-CsTenantNetworkSubnet.md) +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) -[Set-CsTenantNetworkSubnet](Set-CsTenantNetworkSubnet.md) +[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 0c8b286ae0..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 @@ -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 06058895fa..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 @@ -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 a80d0274a2..e393faf0f5 100644 --- a/teams/teams-ps/teams/Get-TeamsApp.md +++ b/teams/teams-ps/teams/Get-TeamsApp.md @@ -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 70% rename from skype/skype-ps/skype/Grant-CsApplicationAccessPolicy.md rename to teams/teams-ps/teams/Grant-CsApplicationAccessPolicy.md index ee37ffd54b..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 @@ -83,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 @@ -154,6 +154,72 @@ 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 @@ -162,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-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 83% rename from skype/skype-ps/skype/Grant-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md index f9b71a4166..76d9afbba6 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsAppPermissionPolicy.md @@ -1,224 +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 [] -``` - -### 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 +--- +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 95% rename from skype/skype-ps/skype/Grant-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsAppSetupPolicy.md index f0a9385327..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 @@ -210,14 +211,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.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 90% rename from skype/skype-ps/skype/Grant-CsTeamsAudioConferencingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsAudioConferencingPolicy.md index 19f6d88282..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 --- @@ -44,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 @@ -185,8 +184,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsAudioConferencingPolicy](Get-CsTeamsAudioConferencingPolicy.md) +[Get-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsaudioconferencingpolicy) -[Set-CsTeamsAudioConferencingPolicy](Set-CsTeamsAudioConferencingPolicy.md) +[Set-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsaudioconferencingpolicy) -[Remove-CsTeamsAudioConferencingPolicy](Remove-CsTeamsAudioConferencingPolicy.md) +[Remove-CsTeamsAudioConferencingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsaudioconferencingpolicy) diff --git a/skype/skype-ps/skype/Grant-CsTeamsCallHoldPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md similarity index 91% rename from skype/skype-ps/skype/Grant-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsCallHoldPolicy.md index 52a76bd2c7..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: jenstr -author: jenstrier ---- - -# 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 93% rename from skype/skype-ps/skype/Grant-CsTeamsChannelsPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsChannelsPolicy.md index ac7ab76156..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 @@ -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 ### 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 85% rename from skype/skype-ps/skype/Grant-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md index 02ea01ccbf..caa013a167 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsComplianceRecordingPolicy.md @@ -1,277 +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] [] -``` - -### 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: -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 -``` - -### -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 - -## 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 93% rename from skype/skype-ps/skype/Grant-CsTeamsCortanaPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md index f90c3901c0..ef2205b07d 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsCortanaPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsCortanaPolicy.md @@ -1,221 +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-msft -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] [] -``` - -### 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 +--- +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 b6c5e1f19e..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 --- @@ -46,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 @@ -56,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 @@ -92,7 +90,6 @@ Accept wildcard characters: False ### -Identity Unique identifier assigned to the Teams enhanced encryption policy. - ```yaml Type: XdsIdentity Parameter Sets: Identity @@ -184,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 89% rename from skype/skype-ps/skype/Grant-CsTeamsFeedbackPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsFeedbackPolicy.md index 2063ab9f22..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: --- @@ -96,7 +96,7 @@ 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 @@ -201,6 +201,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.AD.UserIdParameter @@ -208,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 88% rename from skype/skype-ps/skype/Grant-CsTeamsIPPhonePolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md index 5c097330bf..4e0833c5a5 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsIPPhonePolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsIPPhonePolicy.md @@ -1,219 +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 - -### 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 -``` - -## 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 5d6fb97601..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 @@ -94,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 @@ -111,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 @@ -132,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 @@ -149,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 @@ -167,7 +167,7 @@ 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 @@ -214,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 @@ -239,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/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md similarity index 83% rename from skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md index d1a318cb26..cd29d655c1 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingBrandingPolicy.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsmeetingbrandingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Grant-CsTeamsMeetingBrandingPolicy -author: szymonkatraMSFT -ms.author: szymonkatra +author: serdarsoysal +ms.author: serdars ms.reviewer: manager: stanlythomas --- @@ -135,7 +135,7 @@ Suppresses any confirmation prompts that would otherwise be displayed before mak ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -147,6 +147,9 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-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 @@ -154,12 +157,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file +[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 93% rename from skype/skype-ps/skype/Grant-CsTeamsMeetingBroadcastPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsMeetingBroadcastPolicy.md index 939cb94339..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 @@ -43,7 +42,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 ``` ### -DomainController -Not applicable to online service. +Not applicable to online service. ```yaml Type: Fqdn @@ -195,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 @@ -204,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 70% rename from skype/skype-ps/skype/Grant-CsTeamsMeetingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md index 8390ecb445..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,25 +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) -``` -Grant-CsTeamsMeetingPolicy [-Global] [-PassThru] [[-PolicyName] ] - [-WhatIf] [-Confirm] [] +```powershell +Grant-CsTeamsMeetingPolicy [-Global] [-PassThru] [[-PolicyName] ] [] ``` ### GrantToGroup -``` +```powershell Grant-CsTeamsMeetingPolicy [-PassThru] [[-PolicyName] ] - -Group [-Rank ] [-WhatIf] [-Confirm] [] + [[-Group] ] [-Rank ] [] ``` ### Identity -``` +```powershell Grant-CsTeamsMeetingPolicy [-PassThru] [[-PolicyName] ] - [[-Identity] ] [-WhatIf] [-Confirm] [] + [[-Identity] ] [] ``` ## DESCRIPTION @@ -50,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 @@ -87,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 @@ -102,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 @@ -118,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 @@ -178,25 +160,8 @@ Accept wildcard characters: False ```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 -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -206,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 index a72b0f957e..591125a048 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMeetingTemplatePermissionPolicy.md @@ -152,11 +152,17 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +## OUTPUTS + +## NOTES + ## RELATED LINKS -[Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.yml) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) -[Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) -[Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.yml) +[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 90% rename from skype/skype-ps/skype/Grant-CsTeamsMessagingPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md index 4111daa5cd..cbe96c09cb 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMessagingPolicy.md @@ -1,20 +1,19 @@ --- -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 @@ -205,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 87% rename from skype/skype-ps/skype/Grant-CsTeamsMobilityPolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md index 5e0abcaf97..9ca488f23b 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsMobilityPolicy.md @@ -1,187 +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] ] [-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 +--- +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 index a41288acfc..4eb7f30ac5 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsSharedCallingRoutingPolicy.md @@ -3,11 +3,12 @@ external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Grant-CsTeamsSharedCallingRoutingPolicy schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Grant-CsTeamsSharedCallingRoutingPolicy @@ -158,10 +159,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable This cmdlet was introduced in Teams PowerShell Module 5.5.0. ## RELATED LINKS -[Get-CsTeamsSharedCallingRoutingPolicy](Get-CsTeamsSharedCallingRoutingPolicy.md) +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) -[Set-CsTeamsSharedCallingRoutingPolicy](Set-CsTeamsSharedCallingRoutingPolicy.md) +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) -[Remove-CsTeamsSharedCallingRoutingPolicy](Remove-CsTeamsSharedCallingRoutingPolicy.md) +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) -[New-CsTeamsSharedCallingRoutingPolicy](New-CsTeamsSharedCallingRoutingPolicy.md) +[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 36be7e8b9d..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,32 +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] [] ``` ### 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 @@ -122,10 +123,24 @@ 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 @@ -133,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 95% rename from skype/skype-ps/skype/Grant-CsTeamsVideoInteropServicePolicy.md rename to teams/teams-ps/teams/Grant-CsTeamsVideoInteropServicePolicy.md index 202584c77d..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 @@ -39,7 +39,7 @@ Grant-CsTeamsVideoInteropServicePolicy [-PassThru] [[-PolicyName] ] ``` ## 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. @@ -55,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` @@ -251,8 +251,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-CsTeamsVirtualAppointmentsPolicy.md b/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md index 04900eb579..1203279e74 100644 --- a/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/teams/Grant-CsTeamsVirtualAppointmentsPolicy.md @@ -2,6 +2,7 @@ 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 @@ -42,7 +43,6 @@ This cmdlet applies an instance of the TeamsVirtualAppointmentsPolicy to users o 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 @@ -57,8 +57,7 @@ Assigns a given policy to a user. PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName sms-enabled ``` -Assigns a given policy to a group. - +Assigns a given policy to a group. ### Example 3 ```powershell @@ -186,11 +185,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md) +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) -[New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md) +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) -[Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md) +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) -[Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md) +[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 7d9bb8e8ae..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 --- @@ -32,8 +33,7 @@ Grant-CsTeamsVoiceApplicationsPolicy [-PassThru] [[-PolicyName] ] ``` ## 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 @@ -182,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 73% rename from skype/skype-ps/skype/Grant-CsTenantDialPlan.md rename to teams/teams-ps/teams/Grant-CsTenantDialPlan.md index 82d0a37755..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 +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,17 +19,17 @@ 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 @@ -89,7 +89,7 @@ Accept wildcard characters: False ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -105,7 +105,7 @@ The PolicyName parameter is the name of the tenant dial plan to be assigned. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -153,7 +153,7 @@ The Identity parameter identifies the user to whom the policy should be assigned ```yaml Type: String Parameter Sets: (Identity) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -163,40 +163,8 @@ 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 - -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 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters -This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).` +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -208,10 +176,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## 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 0eee6ca216..6d4fc120b3 100644 --- a/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md +++ b/teams/teams-ps/teams/Grant-CsUserPolicyPackage.md @@ -111,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 81% rename from skype/skype-ps/skype/New-CsAutoAttendant.md rename to teams/teams-ps/teams/New-CsAutoAttendant.md index c1492c3629..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. @@ -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 @@ -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 78% rename from skype/skype-ps/skype/New-CsAutoAttendantCallFlow.md rename to teams/teams-ps/teams/New-CsAutoAttendantCallFlow.md index 7a448d55dc..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 @@ -24,7 +24,6 @@ New-CsAutoAttendantCallFlow -Name -Menu [-Greetings ] [- ## 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 -------------------------- @@ -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 @@ -125,7 +122,7 @@ If specified, DTMF and speech inputs will not be processed while the greeting or 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 65% rename from skype/skype-ps/skype/New-CsAutoAttendantCallableEntity.md rename to teams/teams-ps/teams/New-CsAutoAttendantCallableEntity.md index 802c2e6719..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 @@ -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 2e024ecd5c..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 ] [-OverflowThreshold ] [-TimeoutAction ] [-TimeoutActionTarget ] [-TimeoutThreshold ] [-NoAgentAction ] [-NoAgentActionTarget ] [-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 ] [-NoAgentDisconnectTextToSpeechPrompt ][-NoAgentDisconnectAudioFilePrompt ] [-NoAgentRedirectPersonTextToSpeechPrompt ] [-NoAgentRedirectPersonAudioFilePrompt ] [-NoAgentRedirectVoiceAppTextToSpeechPrompt ] [-NoAgentRedirectVoiceAppAudioFilePrompt ] [-NoAgentRedirectPhoneNumberTextToSpeechPrompt ] [-NoAgentRedirectPhoneNumberAudioFilePrompt ] [-NoAgentRedirectVoicemailTextToSpeechPrompt ] [-NoAgentRedirectVoicemailAudioFilePrompt ] [-NoAgentSharedVoicemailTextToSpeechPrompt ] [-NoAgentSharedVoicemailAudioFilePrompt ] [-EnableNoAgentSharedVoicemailTranscription ] [-EnableNoAgentSharedVoicemailSystemPromptSuppression ] [-ChannelId ] [-ChannelUserObjectId ] [-AuthorizedUsers ] [-HideAuthorizedUsers ] [-WelcomeTextToSpeechPrompt ] [] +New-CsCallQueue -Name [-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 @@ -26,37 +26,38 @@ 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: -> -> - -OverflowDisconnectTextToSpeechPrompt -> - -OverflowDisconnectAudioFilePrompt +> +> - -HideAuthorizedUsers +> - -OverflowActionCallPriority > - -OverflowRedirectPersonTextToSpeechPrompt > - -OverflowRedirectPersonAudioFilePrompt -> - -OverflowRedirectVoiceAppTextToSpeechPrompt -> - -OverflowRedirectVoiceAppAudioFilePrompt -> - -OverflowRedirectPhoneNumberTextToSpeechPrompt -> - -OverflowRedirectPhoneNumberAudioFilePrompt > - -OverflowRedirectVoicemailTextToSpeechPrompt > - -OverflowRedirectVoicemailAudioFilePrompt -> - -TimeoutDisconnectTextToSpeechPrompt -> - -TimeoutDisconnectAudioFilePrompt +> - -TimeoutActionCallPriority > - -TimeoutRedirectPersonTextToSpeechPrompt > - -TimeoutRedirectPersonAudioFilePrompt -> - -TimeoutRedirectVoiceAppTextToSpeechPrompt -> - -TimeoutRedirectVoiceAppAudioFilePrompt -> - -TimeoutRedirectPhoneNumberTextToSpeechPrompt -> - -TimeoutRedirectPhoneNumberAudioFilePrompt > - -TimeoutRedirectVoicemailTextToSpeechPrompt > - -TimeoutRedirectVoicemailAudioFilePrompt -> - -NoAgentDisconnectTextToSpeechPrompt -> - -NoAgentDisconnectAudioFilePrompt +> - -NoAgentActionCallPriority > - -NoAgentRedirectPersonTextToSpeechPrompt > - -NoAgentRedirectPersonAudioFilePrompt -> - -NoAgentRedirectVoiceAppTextToSpeechPrompt -> - -NoAgentRedirectVoiceAppAudioFilePrompt -> - -NoAgentRedirectPhoneNumberTextToSpeechPrompt -> - -NoAgentRedirectPhoneNumberAudioFilePrompt > - -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 @@ -75,7 +76,6 @@ New-CsCallQueue -Name "Help desk" -RoutingMethod Attendant -DistributionLists @( This example creates a Call Queue for the organization named "Help Desk" with music on hold and welcome music audio files. - ## PARAMETERS ### -Name @@ -84,8 +84,8 @@ The Name parameter specifies a unique name for the Call Queue. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: Named @@ -100,8 +100,8 @@ The AgentAlertTime parameter represents the time (in seconds) that a call can re ```yaml Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -116,8 +116,8 @@ The AllowOptOut parameter indicates whether or not agents can opt in or opt out ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -132,8 +132,8 @@ The DistributionLists parameter lets you add all the members of the distribution ```yaml Type: List Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -148,8 +148,8 @@ This parameter is reserved for Microsoft internal use only. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -164,8 +164,8 @@ The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the defa ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -180,8 +180,8 @@ The WelcomeMusicAudioFileId parameter represents the audio file to play when cal ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -196,8 +196,8 @@ The MusicOnHoldAudioFileId parameter represents music to play when callers are p ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -214,8 +214,8 @@ PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -230,8 +230,36 @@ The OverflowActionTarget parameter represents the target of the overflow action. ```yaml Type: String 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 +``` + +### -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 @@ -241,13 +269,13 @@ 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 +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 +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -264,8 +292,8 @@ PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -280,8 +308,36 @@ The TimeoutActionTarget represents the target of the timeout action. If the Time ```yaml Type: String 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 +``` + +### -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 @@ -291,14 +347,14 @@ 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 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 +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -307,6 +363,24 @@ 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. @@ -315,8 +389,8 @@ PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -331,8 +405,36 @@ The NoAgentActionTarget represents the target of the no agent action. If the NoA ```yaml Type: String 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 +``` + +### -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 @@ -349,8 +451,8 @@ PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -365,8 +467,8 @@ The PresenceBasedRouting parameter indicates whether or not presence based routi ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -385,8 +487,8 @@ The ConferenceMode parameter indicates whether or not Conference mode will be ap ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -401,8 +503,8 @@ The Users parameter lets you add agents to the Call Queue. This parameter expect ```yaml Type: List Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -419,8 +521,8 @@ You can query the supported languages using the Get-CsAutoAttendantSupportedLang ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -435,8 +537,8 @@ This parameter is reserved for Microsoft internal use only. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -453,8 +555,8 @@ Only Call Queue managed by a Teams Channel will be able to use this feature. For ```yaml Type: List Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -464,13 +566,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -485,8 +587,8 @@ The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -496,13 +598,15 @@ Accept wildcard characters: False ``` ### -OverflowRedirectPersonTextToSpeechPrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -512,13 +616,15 @@ Accept wildcard characters: False ``` ### -OverflowRedirectPersonAudioFilePrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -528,13 +634,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -544,13 +650,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -560,13 +666,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -576,13 +682,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -592,13 +698,15 @@ Accept wildcard characters: False ``` ### -OverflowRedirectVoicemailTextToSpeechPrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -608,13 +716,15 @@ Accept wildcard characters: False ``` ### -OverflowRedirectVoicemailAudioFilePrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -629,8 +739,8 @@ The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Sp ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -645,8 +755,8 @@ The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identi ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -661,8 +771,8 @@ The EnableOverflowSharedVoicemailTranscription parameter is used to turn on tran ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -677,8 +787,8 @@ The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -688,13 +798,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -709,8 +819,8 @@ The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier f ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -720,13 +830,15 @@ Accept wildcard characters: False ``` ### -TimeoutRedirectPersonTextToSpeechPrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -736,13 +848,15 @@ 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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -752,13 +866,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -768,13 +882,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -784,13 +898,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -800,13 +914,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -816,13 +930,15 @@ Accept wildcard characters: False ``` ### -TimeoutRedirectVoicemailTextToSpeechPrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -832,13 +948,15 @@ Accept wildcard characters: False ``` ### -TimeoutRedirectVoicemailAudioFilePrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -853,8 +971,8 @@ The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Spe ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -869,8 +987,8 @@ The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identif ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -885,8 +1003,8 @@ The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on trans ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -901,8 +1019,8 @@ The EnableTimeoutSharedVoicemailSystemPromptSuppress parameter is used to turn o ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -912,13 +1030,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -933,8 +1051,8 @@ The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier f ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -944,13 +1062,15 @@ Accept wildcard characters: False ``` ### -NoAgentRedirectPersonTextToSpeechPrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -960,13 +1080,15 @@ Accept wildcard characters: False ``` ### -NoAgentRedirectPersonAudioFilePrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -976,13 +1098,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -992,13 +1114,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1008,13 +1130,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1023,14 +1145,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentsRedirectPhoneNumberAudioFilePrompt -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. +### -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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1040,13 +1162,15 @@ Accept wildcard characters: False ``` ### -NoAgentRedirectVoicemailTextToSpeechPrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1056,13 +1180,15 @@ Accept wildcard characters: False ``` ### -NoAgentRedirectVoicemailAudioFilePrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1077,8 +1203,8 @@ The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Spe ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1093,8 +1219,8 @@ The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identif ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1109,8 +1235,8 @@ The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on trans ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1125,8 +1251,8 @@ The EnableNoAgentSharedVoicemailSystemPromptSuppress parameter is used to turn o ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1141,8 +1267,8 @@ Id of the channel to connect a call queue to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1157,8 +1283,48 @@ Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx ```yaml Type: Guid 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 +``` + +### -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 @@ -1168,13 +1334,13 @@ 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). +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1184,13 +1350,15 @@ Accept wildcard characters: False ``` ### -HideAuthorizedUsers -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). +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1214,6 +1382,301 @@ 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). @@ -1227,3 +1690,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 68% rename from skype/skype-ps/skype/New-CsCallingLineIdentity.md rename to teams/teams-ps/teams/New-CsCallingLineIdentity.md index 01a6e04784..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,21 +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 - -**Note**: The use of CallingIDSubstitute Service has been deprecated. You are no longer able to create new Caller ID policies using CallingIDSubstitute Service and existing policies using CallingIDSubstitute Service are not being honored. You should use CallingIDSubstitute Resource instead. - 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. - If CallerIdSubstitute is given as "Resource", then ResourceAccount cannot be empty. - + ## EXAMPLES ### Example 1 @@ -72,8 +69,8 @@ The Identity parameter identifies the Caller ID policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: True Position: 1 @@ -85,13 +82,13 @@ Accept wildcard characters: False ### -BlockIncomingPstnCallerID The BlockIncomingPstnCallerID switch determines whether to block the incoming Caller ID. The default value is false. -The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN caller to a user. If this is set to True and if this policy is assigned to a user, then Caller ID for incoming calls is suppressed/anonymous. +The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN caller to a user. If this is set to True and if this policy is assigned to a user, then Caller ID for incoming calls is suppressed/anonymous. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -101,15 +98,13 @@ Accept wildcard characters: False ``` ### -CallingIDSubstitute -**Note**: The use of CallingIDSubstitute Service will be deprecated and you can't create new Caller ID policies with it. You should use CallingIDSubstitute Resource instead. - 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 @@ -125,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 @@ -140,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 @@ -160,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 @@ -177,27 +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 -**Note**: The use of CallingIDSubstitute Service and -ServiceNumber will be deprecated and you can't create new Caller ID policies with it. You should use CallingIDSubstitute Resource and -ResourceAccount instead. - -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 @@ -207,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 @@ -223,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 @@ -239,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 @@ -253,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 5909814db7..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 @@ -60,5 +58,5 @@ The New-CsCloudCallDataConnection cmdlet is only supported in commercial environ ## 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 de492dc2e2..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 @@ -29,8 +30,8 @@ New-CsGroupPolicyAssignment -GroupId -PolicyType -PolicyName < > - 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 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. @@ -40,12 +41,11 @@ Once a group policy assignment is created, the policy assignment will be propaga > [!NOTE] > - 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 @@ -159,7 +159,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -PassThru Returns true when the command succeeds @@ -175,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. @@ -208,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 @@ -219,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/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md similarity index 81% rename from skype/skype-ps/skype/New-CsOnlineApplicationInstance.md rename to teams/teams-ps/teams/New-CsOnlineApplicationInstance.md index 282a8e8cad..0254f15626 100644 --- a/skype/skype-ps/skype/New-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/teams/New-CsOnlineApplicationInstance.md @@ -1,19 +1,19 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csonlineapplicationinstance +online version: https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance applicable: Microsoft Teams title: New-CsOnlineApplicationInstance schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- # New-CsOnlineApplicationInstance ## SYNOPSIS -Creates an application instance in Microsoft Entra ID. +Creates an application instance in Microsoft Entra ID. ## SYNTAX @@ -133,7 +133,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 @@ -143,10 +143,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) -[Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) -[Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) +[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 78% rename from skype/skype-ps/skype/New-CsOnlineLisCivicAddress.md rename to teams/teams-ps/teams/New-CsOnlineLisCivicAddress.md index 973f4a2083..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 -CountryOrRegion 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 77% rename from skype/skype-ps/skype/New-CsOnlineLisLocation.md rename to teams/teams-ps/teams/New-CsOnlineLisLocation.md index a1552c19a9..418b3f5aa2 100644 --- a/skype/skype-ps/skype/New-CsOnlineLisLocation.md +++ b/teams/teams-ps/teams/New-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/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: --- @@ -17,18 +17,8 @@ Use the New-CsOnlineLisLocation cmdlet to create a new emergency dispatch locati ## 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 @@ -49,7 +39,7 @@ Specifies the unique identifier of the civic address that will contain the new l ```yaml Type: Guid -Parameter Sets: ExistingCivicAddress +Parameter Sets: (All) Aliases: Applicable: Microsoft Teams @@ -65,20 +55,7 @@ Specifies an administrator-defined description of the new location. For example, ```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 @@ -92,7 +69,7 @@ Accept wildcard characters: False ### -CountryOrRegion Specifies the country or region of the civic address. -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -110,7 +87,7 @@ Accept wildcard characters: False ### -City Specifies the city of the civic address. -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -128,7 +105,7 @@ Accept wildcard characters: False ### -CityAlias Specifies the city alias. -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -146,7 +123,7 @@ Accept wildcard characters: False ### -CompanyName Specifies the name of your organization. -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -164,7 +141,7 @@ Accept wildcard characters: False ### -CompanyTaxId The company tax ID. -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -198,7 +175,7 @@ Accept wildcard characters: False ### -Description Specifies an administrator defined description of the civic address. -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -232,7 +209,7 @@ Accept wildcard characters: False ### -HouseNumber Specifies the numeric portion of the civic address. -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -251,7 +228,7 @@ 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. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -269,7 +246,7 @@ 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. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -287,7 +264,7 @@ 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. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -305,7 +282,7 @@ Accept wildcard characters: False ### -PostalCode Specifies the postal code of the civic address. -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -323,7 +300,7 @@ Accept wildcard characters: False ### -PostDirectional 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. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -341,7 +318,7 @@ Accept wildcard characters: False ### -PreDirectional 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. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -359,7 +336,7 @@ Accept wildcard characters: False ### -StateOrProvince Specifies the state or province of the civic address. -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -377,7 +354,7 @@ Accept wildcard characters: False ### -StreetName Specifies the street name of the civic address. -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -395,7 +372,7 @@ 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. -**Note:** This parameter is not supported and will be deprecated. +**Note:** This parameter is not supported and is deprecated. ```yaml Type: String @@ -449,7 +426,7 @@ Suppresses the display of any non-fatal error message that might arise when runn ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -470,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 96% rename from skype/skype-ps/skype/New-CsOnlinePSTNGateway.md rename to teams/teams-ps/teams/New-CsOnlinePSTNGateway.md index d2cb1fff54..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 @@ -369,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 @@ -439,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 @@ -455,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 83% rename from skype/skype-ps/skype/New-CsOnlineSchedule.md rename to teams/teams-ps/teams/New-CsOnlineSchedule.md index e5f5474fa1..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,7 +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](New-CsAutoAttendantCallHandlingAssociation.md). +- Schedules can then be used by [New-CsAutoAttendantCallHandlingAssociation](https://learn.microsoft.com/powershell/module/teams/new-csautoattendantcallhandlingassociation). ## EXAMPLES @@ -96,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 @@ -112,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 @@ -128,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 @@ -144,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 @@ -160,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 @@ -176,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 @@ -192,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 @@ -208,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 @@ -224,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 @@ -242,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 @@ -258,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 @@ -274,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 @@ -289,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 @@ -299,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 54259d53f1..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 @@ -172,7 +172,7 @@ Specifies the telephone number search order country/region. Use `Get-CsOnlineTel ```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 e789568248..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,7 +121,7 @@ Channel=@{` }` } -PS C:> New-CsTeamTemplate -Locale en-US -Body $template +PS C:\> New-CsTeamTemplate -Locale en-US -Body $template ``` Create template from scratch @@ -130,7 +129,6 @@ 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 @@ -677,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. @@ -731,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. @@ -806,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/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md b/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md similarity index 71% rename from skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md index 26efeb8d78..ff00d0c8a6 100644 --- a/skype/skype-ps/skype/New-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsAppSetupPolicy.md @@ -1,13 +1,9 @@ --- 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 +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsappsetuppolicy +applicable: Microsoft Teams title: New-CsTeamsAppSetupPolicy schema: 2.0.0 -ms.reviewer: -manager: bulenteg -ms.author: tomkau -author: tomkau --- # New-CsTeamsAppSetupPolicy @@ -22,9 +18,21 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ## SYNTAX ``` -New-CsTeamsAppSetupPolicy [-Description ] [-AppPresetList ] [-WhatIf] - [-PinnedAppBarApps ] [-AllowUserPinning ] [-Confirm] [[-Identity] ] [-Tenant ] - [-InMemory] [-AllowSideLoading ] [-Force] [-AsJob] +New-CsTeamsAppSetupPolicy [-Identity] + [-AllowSideLoading ] + [-AllowUserPinning ] + [-AppPresetList ] + [-Confirm] + [-Description ] + [-Force] + [-PinnedAppBarApps ] + [-PinnedCallingBarApps ] + [-PinnedMessageBarApps ] + [-AppPresetMeetingList ] + [-AdditionalCustomizationApps ] + [-Tenant ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -46,7 +54,7 @@ Create a new TeamsAppSetupPolicy, if no parameters are specified, the Global Pol ### Example 2 ```powershell -New-CsTeamsAppSetupPolicy -Identity (Get-Date -Format FileDateTimeUniversal) -AllowSideLoading $true -AllowUserPinning $true +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. @@ -62,6 +70,7 @@ $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 @@ -73,6 +82,7 @@ $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 @@ -84,35 +94,36 @@ $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 -### -Description -Description of the app setup policy. +### -Identity +Name of App setup policy. If empty, all Identities will be used by default. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Name of App setup policy. If empty, all Identities will be used by default. +### -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: XdsIdentity -Parameter Sets: Identity +Type: Boolean +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -133,11 +144,41 @@ 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. +### -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: Boolean +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: @@ -163,6 +204,21 @@ 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. @@ -178,11 +234,26 @@ 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. +### -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: Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[] +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: @@ -208,9 +279,23 @@ 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). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -220,7 +305,6 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp - ## OUTPUTS ### System.Object 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 86% rename from skype/skype-ps/skype/New-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md index 00a0fcc559..92744364e9 100644 --- a/skype/skype-ps/skype/New-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsCallHoldPolicy.md @@ -1,191 +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: jenstr -author: jenstrier ---- - -# 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](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 72% rename from skype/skype-ps/skype/New-CsTeamsCallingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsCallingPolicy.md index 967b61447c..638a131b09 100644 --- a/skype/skype-ps/skype/New-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsCallingPolicy.md @@ -1,557 +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] [-Description ] [-AllowPrivateCalling ] [-AllowWebPSTNCalling ] - [-AllowSIPDevicesCalling ] [-AllowVoicemail ] [-AllowCallGroups ] [-AllowDelegation ] - [-AllowCallForwardingToUser ] [-AllowCallForwardingToPhone ] [-PreventTollBypass ] - [-BusyOnBusyEnabledType ] [-MusicOnHoldEnabledType ] [-AllowCloudRecordingForCalls ] - [-AllowTranscriptionForCalling ] [-PopoutForIncomingPstnCalls ] [-PopoutAppPathForIncomingPstnCalls ] - [-LiveCaptionsEnabledTypeForCalling ] [-AutoAnswerEnabledType ] [-SpamFilteringEnabledType ] - [-CallRecordingExpirationDays ] [-AllowCallRedirect ] - [-InboundPstnCallRoutingTreatment ] [-InboundFederatedCallRoutingTreatment ] [-Force] [-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 - -### -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 -``` - -### -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 -``` - -### -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 -``` - -### -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: Prohibts 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 -``` - -### -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 - -### 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 77% rename from skype/skype-ps/skype/New-CsTeamsChannelsPolicy.md rename to teams/teams-ps/teams/New-CsTeamsChannelsPolicy.md index 076338ecb4..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 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](/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 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](/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 88% rename from skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md index 08134ec34f..e1caae78f9 100644 --- a/skype/skype-ps/skype/New-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsComplianceRecordingPolicy.md @@ -1,317 +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 ] - [-RecordReroutedCalls ] [-Description ] - [-ComplianceRecordingApplications ] [-CustomBanner ] - [-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 -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not 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 031668c47b..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-msft -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 index 12572dc640..4ed97c99b6 100644 --- a/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/teams/New-CsTeamsCustomBannerText.md @@ -1,17 +1,17 @@ --- 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 -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. +Enables administrators to configure a custom text on the banner displayed when compliance recording bots start recording the call. ## SYNTAX @@ -73,11 +73,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 @@ -85,12 +83,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) -[New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) -[Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) +[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/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md b/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md similarity index 73% rename from skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md rename to teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md index bd555562e6..693ea5b9cd 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingExtendedNotification.md +++ b/teams/teams-ps/teams/New-CsTeamsEmergencyCallingExtendedNotification.md @@ -1,120 +1,116 @@ ---- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csteamsemergencycallingextendednotification -applicable: Microsoft Teams -title: New-CsTeamsEmergencyCallingExtendedNotification -author: jenstrier -ms.author: jenstr -manager: roykuntz -ms.reviewer: -schema: 2.0.0 ---- - -# New-CsTeamsEmergencyCallingExtendedNotification - -## SYNOPSIS - -## SYNTAX - -``` -New-CsTeamsEmergencyCallingExtendedNotification -EmergencyDialString [-NotificationGroup ] - [-NotificationDialOutNumber ] [-NotificationMode ] [] -``` - -## DESCRIPTION - -**Note**: The use of extended notifications for emergency calling and this cmdlet is currently not supported. - -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 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 -``` - -### -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 - -The use of extended notifications for emergency calling and this cmdlet is currently not supported. - -## RELATED LINKS - -[Set-CsTeamsEmergencyCallingPolicy](Set-CsTeamsEmergencyCallingPolicy.md) - -[New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) +--- +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/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md similarity index 66% rename from skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsEmergencyCallingPolicy.md index dfe2c9394b..60f9db0fb7 100644 --- a/skype/skype-ps/skype/New-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/teams/New-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/new-csteamsemergencycallingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy applicable: Microsoft Teams title: New-CsTeamsEmergencyCallingPolicy -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars manager: roykuntz ms.reviewer: chenc schema: 2.0.0 @@ -27,20 +27,37 @@ This cmdlet creates a new Teams Emergency Calling policy. Emergency calling poli ## EXAMPLES -### Example 1 +### 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 -New-CsTeamsEmergencyCallingPolicy -Identity TestECP -Description "Test ECP" -NotificationGroup "alert@contoso.com" -NotificationDialOutNumber "+14255551234" -NotificationMode NotificationOnly -ExternalLocationLookupMode Enabled +$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} ``` -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. +### 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
    • +
-### Example 2 ```powershell -New-CsTeamsEmergencyCallingPolicy -Identity "TestECP2" -NotificationGroup "123@contoso.com;567@contoso.com" +$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} ``` -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 by ";". - ## PARAMETERS ### -Identity @@ -90,8 +107,6 @@ Accept wildcard characters: False ### -ExtendedNotifications -**Note**: The use of extended notifications and this parameter is currently not supported. - 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. @@ -140,7 +155,7 @@ 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. +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 @@ -203,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 @@ -212,16 +227,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-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) -[New-CsTeamsEmergencyCallingExtendedNotification](New-CsTeamsEmergencyCallingExtendedNotification.md) +[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 c04a8f6a45..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 --- @@ -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 @@ -95,7 +94,6 @@ Accept wildcard characters: False ### -Identity Unique identifier assigned to the Teams enhanced encryption policy. - ```yaml Type: XdsIdentity Parameter Sets: (All) @@ -172,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 b0270057ef..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 -``` +```powershell New-CsTeamsEventsPolicy [-Identity] [-AllowWebinars ] [-AllowTownhalls ] [-AllowEmailEditing ] [-Description ] -[-UseMicrosoftECDN ] [-EventAccessType ] [-WhatIf] [-Confirm] [] +[-TownhallEventAttendeeAccess ] [-RecordingForTownhall ] [-RecordingForWebinar ] +[-TranscriptionForTownhall ] [-TranscriptionForWebinar ] [-AllowEventIntegrations ] [-TownhallChatExperience ] +[-UseMicrosoftECDN ] [-EventAccessType ] [-BroadcastPremiumApps ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -40,13 +43,11 @@ 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) @@ -60,8 +61,7 @@ Accept wildcard characters: False ``` ### -UseMicrosoftECDN -This setting governs whether the global 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. - +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 @@ -76,13 +76,11 @@ Accept wildcard characters: False ``` ### -AllowTownhalls -This setting governs if a user can create town halls using Teams Events. +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) @@ -95,14 +93,30 @@ 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. +This setting governs if a user is allowed to edit the communication emails in Teams Town Hall or Teams Webinar events. Possible values are: - **Enabled**: Enables editing of communication emails. - **Disabled**: Disables editing of communication emails. - - ```yaml Type: String Parameter Sets: (All) @@ -116,14 +130,29 @@ Accept wildcard characters: False ``` ### -EventAccessType -This setting governs which users can access the Town hall event and access the event registration page or the event site to register for a Webinar. It also governs which user type is allowed to join the session or sessions in the event for both event types. +This setting governs which users can access the Town hall event and access the event registration page or the event site to register for a Webinar. It also governs which user type is allowed to join the session or sessions in the event for both event types. Possible values are: - **Everyone**: Enables creating events to allow in-tenant, guests, federated, and anonymous (external to the tenant) users to register and join the event. - - **EveryoneInCompanyExcludingGuests**: For Webinar - enables creating events to allow only in-tenant users to register and join the event. For Town hall - enables creating events to allow only in-tenant users to join the event (Note: for Town hall, in-tenant users include guests; this parameter will disable public Town halls). + - **EveryoneInCompanyExcludingGuests**: For Webinar - enables creating events to allow only in-tenant users to register and join the event. For Town hall - enables creating events to allow only in-tenant users to join the event (Note: for Town hall, in-tenant users include guests; this parameter will disable public Town halls). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Everyone +Accept pipeline input: False +Accept wildcard characters: False +``` +### -AllowedQuestionTypesInRegistrationForm +This setting governs which users in a tenant can add which registration form questions to an event registration page for attendees to answer when registering for the event. +Possible values are: DefaultOnly, DefaultAndPredefinedOnly, AllQuestions. ```yaml Type: String @@ -132,7 +161,155 @@ Aliases: Required: False Position: Named -Default value: Everyone +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 ``` @@ -155,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) @@ -171,7 +347,6 @@ Accept wildcard characters: False ### -Identity Unique identifier assigned to the Teams Events policy. - ```yaml Type: String Parameter Sets: (All) @@ -203,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 @@ -211,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 index 39eaaae4bd..afae69de7e 100644 --- a/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md +++ b/teams/teams-ps/teams/New-CsTeamsHiddenMeetingTemplate.md @@ -11,17 +11,17 @@ schema: 2.0.0 # New-CsTeamsHiddenMeetingTemplate ## SYNOPSIS -This cmdlet is used to create a `HiddenMeetingTemplate` object for use with the [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.yml) and [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.yml) cmdlets. +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 [] +New-CsTeamsHiddenMeetingTemplate -Id [] ``` ## DESCRIPTION -Creates an object that can be supplied as `HiddenMeetingTemplate` to the [New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.yml) and [Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.yml) cmdlets. +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 @@ -35,7 +35,7 @@ PS> $hiddentemplate_1 = New-CsTeamsHiddenMeetingTemplate -Id customtemplate_9ab0 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](New-CsTeamsMeetingTemplatePermissionPolicy.yml). +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 @@ -58,9 +58,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). +## INPUTS + +## OUTPUTS + +## NOTES + ## RELATED LINKS -[Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.yml) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) -[Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.yml) \ No newline at end of file +[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 index dc52c24668..5df0f7b450 100644 --- a/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md +++ b/teams/teams-ps/teams/New-CsTeamsHiddenTemplate.md @@ -5,7 +5,7 @@ online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsh title: New-CsTeamsHiddenTemplate author: yishuaihuang4 ms.author: yishuaihuang -ms.reviewer: +ms.reviewer: manager: weiliu2 schema: 2.0.0 --- @@ -13,7 +13,7 @@ schema: 2.0.0 # New-CsTeamsHiddenTemplate ## SYNOPSIS -This cmdlet is used to create a `HiddenTemplate` object for use with the [New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) and [Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) cmdlets. +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 @@ -22,7 +22,7 @@ New-CsTeamsHiddenTemplate -Id [] ``` ## DESCRIPTION -Creates an object that can be supplied as `HiddenTemplate` to the [New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) and [Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) cmdlets. +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 @@ -31,7 +31,7 @@ Creates an object that can be supplied as `HiddenTemplate` to the [New-CsTeamsTe 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](New-CsTeamsTemplatePermissionPolicy.md). +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 @@ -64,6 +64,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) -[Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) +[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/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md similarity index 67% rename from skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md index 05fd159bcf..6a2c7ee7cd 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMeetingBrandingPolicy.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/skype/new-csteamsmeetingbrandingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy schema: 2.0.0 title: New-CsTeamsMeetingBrandingPolicy -author: szymonkatraMSFT -ms.author: szymonkatra +author: serdarsoysal +ms.author: serdars ms.reviewer: manager: stanlythomas --- @@ -17,17 +17,18 @@ The **CsTeamsMeetingBrandingPolicy** cmdlet enables administrators to control th ## SYNTAX -``` +```powershell New-CsTeamsMeetingBrandingPolicy [-MeetingBackgroundImages ] [-MeetingBrandingThemes ] [-DefaultTheme ] [-EnableMeetingOptionsThemeOverride ] + [-EnableNdiAssuranceSlate ] [-NdiAssuranceSlateImages ] [-RequireBackgroundEffect ] [-EnableMeetingBackgroundImages ] [-Identity] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -This cmdlet creates a new **TeamsMeetingBrandingPolicy**. +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. @@ -137,6 +138,51 @@ 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. @@ -158,7 +204,7 @@ Suppresses any confirmation prompts that would otherwise be displayed before mak ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -185,18 +231,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). +## INPUTS + +## OUTPUTS + ## NOTES Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file +[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 57% rename from skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md index 3824fee366..8c7b734046 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMeetingPolicy.md @@ -1,44 +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 ] [-AllowedStreamingMediaInput ] [-AutomaticallyStartCopilot ] [-Copilot ] -[-AllowWatermarkForScreenSharing ] [-AllowWatermarkForCameraVideo ] [-AllowLocalRecording] [-ExternalMeetingJoin ] [-CopyRestriction ] [-VoiceIsolation ] -[-ContentSharingInExternalMeetings ] -[-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 @@ -47,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 ``` @@ -55,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 ``` @@ -65,49 +149,55 @@ 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 -### -AllowAnonymousUsersToDialOut -Determines whether anonymous users are allowed to dial out to a PSTN number. Set this to TRUE to allow anonymous users to dial out. Set this to FALSE to prohibit anonymous users from dialing out. - -> [!NOTE] -> This parameter is temporarily disabled. +### -Identity +Specify the name of the policy being created. ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AutomaticallyStartCopilot +### -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 -This policy gives admins the ability to auto-start Copilot. +Possible values: + +- Disabled +- Enabled ```yaml Type: String Parameter Sets: (All) Aliases: +Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -Copilot +### -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. -This policy gives admins the ability to choose if Copilot will be enabled with a persisted transcript or a non-persisted transcript. +> [!NOTE] +> This parameter is temporarily disabled. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -121,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. @@ -152,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). 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 @@ -184,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 @@ -194,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 @@ -214,22 +306,29 @@ 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 ``` -### -AllowLocalRecording -This parameter is reserved for internal Microsoft use. + +### -AllowChannelMeetingScheduling +Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings. Note this only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml Type: Boolean @@ -243,11 +342,11 @@ 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. +### -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: @@ -258,8 +357,8 @@ 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. +### -AllowDocumentCollaboration +This setting will allow admins to choose which users will be able to use the Document Collaboration feature. ```yaml Type: String @@ -273,8 +372,9 @@ 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 +### -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 @@ -288,23 +388,30 @@ 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. +### -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: 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. +### -AllowExternalNonTrustedMeetingChat + +This field controls whether a user is allowed to chat in external meetings with users from non trusted organizations. ```yaml Type: Boolean @@ -313,13 +420,13 @@ 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 +### -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 @@ -333,8 +440,8 @@ 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 +### -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 @@ -348,8 +455,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 +### -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 @@ -358,13 +465,13 @@ Aliases: Required: False Position: Named -Default value: None +Default value: True 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 +### -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 @@ -378,8 +485,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 +### -AllowLocalRecording +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -393,8 +500,8 @@ 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 +### -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 @@ -403,31 +510,28 @@ Aliases: Required: False Position: Named -Default value: None +Default value: TRUE 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. + +### -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: 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 +### -AllowMeetingReactions +Set to false to disable Meeting Reactions. ```yaml Type: Boolean @@ -436,25 +540,21 @@ 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. +### -AllowMeetingRegistration +Controls if a user can create a webinar meeting. The default value is True. -This setting also applies to participants joining via a PSTN device (i.e. a traditional phone). +Possible values: + +- true +- false ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -465,8 +565,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -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. +### -AllowNDIStreaming +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -475,47 +575,46 @@ Aliases: Required: False Position: Named -Default value: TRUE +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -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: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False 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. +### -AllowOrganizersToOverrideLobbySettings +Set this parameter to true to enable Organizers to override lobby settings. ```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 ``` -### -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. +### -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: @@ -526,26 +625,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy being created. +### -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: 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 ``` -### -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-. +### -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: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -556,11 +655,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaBitRateKb -Determines the media bit rate for audio/video/app sharing transmissions in meetings. +### -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: UInt32 +Type: Boolean Parameter Sets: (All) Aliases: @@ -571,11 +670,11 @@ 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. +### -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: @@ -586,19 +685,11 @@ 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. +### -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: Guid +Type: Boolean Parameter Sets: (All) Aliases: @@ -609,14 +700,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -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: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -625,43 +715,38 @@ 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. +### -AllowScreenContentDigitization +This parameter is reserved for internal Microsoft use. ```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. +### -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: 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. +### -AllowTasksFromTranscript +This policy setting allows for the extraction of AI-Assisted Action Items/Tasks from the Meeting Transcript. ```yaml Type: String @@ -675,7 +760,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNDIStreaming +### -AllowTrackingInReport This parameter is reserved for internal Microsoft use. ```yaml @@ -690,14 +775,27 @@ 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. +### -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 -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: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowUserToJoinExternalMeeting +Possible values are: + +- Enabled +- FederatedOnly +- Disabled ```yaml Type: String @@ -706,13 +804,13 @@ Aliases: Required: False Position: Named -Default value: EveryoneUserOverride +Default value: Disabled 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. +### -AllowWatermarkCustomizationForCameraVideo +Allows the admin to grant customization permissions to a meeting organizer ```yaml Type: Boolean @@ -726,8 +824,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. +### -AllowWatermarkCustomizationForScreenSharing +Allows the admin to grant customization permissions to a meeting organizer ```yaml Type: Boolean @@ -736,13 +834,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. +### -AllowWatermarkForScreenSharing +This setting allows scheduling meetings with watermarking for screen sharing enabled. ```yaml Type: Boolean @@ -756,78 +854,77 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserToJoinExternalMeeting -Possible values are: -- Enabled -- FederatedOnly -- Disabled +### -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 ``` -### -EnrollUserOverride -Possible values are: -- Disabled -- Enabled +### -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: 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 +### -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: 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. +### -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: Boolean +Type: String Parameter Sets: (All) Aliases: - Required: False Position: Named -Default value: True +Default value: OneTimePasscode Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamsCameraFarEndPTZMode -Possible values are: -- Disabled -- AutoAcceptInTenant -- AutoAcceptAll +### -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 @@ -836,28 +933,38 @@ Aliases: Required: False Position: Named -Default value: Disabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMeetingReactions -Set to false to disable Meeting Reactions. +### -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: 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. +### -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 @@ -871,45 +978,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMeetingRegistration -Controls if a user can create a webinar meeting. The default value is True. +### -AutomaticallyStartCopilot +> [!Note] +> This feature has not been fully released yet, so the setting will have no effect.* -Possible values: -- true -- false +This setting gives admins the ability to auto-start Copilot. + +Possible values are: + +- Enabled +- Disabled ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: Disabled 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. +### -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: Boolean +Type: List Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: Empty List Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowScreenContentDigitization -This parameter is reserved for internal Microsoft use. +### -CaptchaVerificationForMeetingJoin +Require a verification check for meeting join. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -920,11 +1033,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTrackingInReport -This parameter is reserved for internal Microsoft use. +### -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: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -935,8 +1053,13 @@ 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. +### -ConnectToMeetingControls +Allows external connections of thirdparty apps to Microsoft Teams + +Possible values are: + +Enabled +Disabled ```yaml Type: String @@ -950,18 +1073,13 @@ 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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -970,12 +1088,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RoomAttributeUserOverride -Possible values: - -- Off -- Distinguish -- Attribute +### -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 @@ -989,11 +1103,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpeakerAttributionMode -Possible values: +### -Copilot +This setting allows the admin to choose whether Copilot will be enabled with a persisted transcript or a non-persisted transcript. -- EnabledUserOverride -- Disabled +Possible values are: + +- Enabled +- EnabledWithTranscript ```yaml Type: String @@ -1002,38 +1118,32 @@ Aliases: Required: False Position: Named -Default value: None +Default value: EnabledWithTranscript 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 +### -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. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: TRUE 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. +### -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: Int32 +Type: String Parameter Sets: (All) Aliases: @@ -1044,28 +1154,30 @@ 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). +### -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. -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. +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: -Applicable: Microsoft Teams Required: False Position: Named -Default value: None +Default value: EveryoneUserOverride 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. +### -DetectSensitiveContentDuringScreenSharing +Allows the admin to enable sensitive content detection during screen share. ```yaml Type: Boolean @@ -1074,40 +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: None +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowedStreamingMediaInput -Enables the use of RTMP-In in Teams meetings. +### -ExplicitRecordingConsent +Set participant agreement and notification for Recording, Transcript, Copilot in Teams meetings. -Possible values are: -- \ -- RTMP +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 @@ -1115,41 +1230,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForScreenSharing -This setting allows scheduling meetings with watermarking for screen sharing enabled. +### -ExternalMeetingJoin +Possible values are: + +- EnabledForAnyone +- EnabledForTrustedOrgs +- Disabled ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: EnabledForAnyone Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForCameraVideo -This setting allows scheduling meetings with watermarking for video enabled. +### -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: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalMeetingJoin -Possible values are: -- EnabledForAnyone -- EnabledForTrustedOrgs -- Disabled +### -InfoShownInReportMode +This policy controls what kind of information get shown for the user's attendance in attendance report/dashboard. ```yaml Type: String @@ -1158,21 +1274,19 @@ Aliases: Required: False Position: Named -Default value: EnabledForAnyone +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceIsolation -Determines whether you provide support for your users to enable voice isolation in Teams meeting calls. -Possible values are: -- Enabled (default) -- Disabled +### -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: String +Type: SwitchParameter Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -1180,12 +1294,373 @@ 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. +### -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 -- EnabledWithTranscript ```yaml Type: String @@ -1194,25 +1669,124 @@ Aliases: Required: False Position: Named -Default value: EnabledWithTranscript +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -AutomaticallyStartCopilot +### -TeamsCameraFarEndPTZMode +Possible values are: + +- Disabled +- AutoAcceptInTenant +- AutoAcceptAll -*Note: This feature has not been fully released yet, so the setting will have no effect.* +```yaml +Type: String +Parameter Sets: (All) +Aliases: -This setting gives admins the ability to auto-start Copilot. +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 + +- 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 @@ -1221,11 +1795,166 @@ 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 ### System.Object diff --git a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md index 753a7d2871..48a5347d44 100644 --- a/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMeetingTemplatePermissionPolicy.md @@ -20,7 +20,7 @@ Creates a new instance of the TeamsMeetingTemplatePermissionPolicy. ``` ## 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](Get-CsTeamsMeetingTemplateConfiguration.yml) and [Get-CsTeamsFirstPartyMeetingTemplateConfiguration](Get-CsTeamsFirstPartyMeetingTemplateConfiguration.yml) respectively. +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 @@ -63,7 +63,7 @@ Accept wildcard characters: False ### -HiddenMeetingTemplates The list of meeting template IDs to hide. -The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.yml). +The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate). ```yaml Type: HiddenMeetingTemplate[] @@ -96,13 +96,19 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +## OUTPUTS + +## NOTES + ## RELATED LINKS -[New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.yml) +[New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate) -[Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) -[Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) -[Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) -[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Grant-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingtemplatepermissionpolicy) diff --git a/skype/skype-ps/skype/New-CsTeamsMessagingPolicy.md b/teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md similarity index 52% rename from skype/skype-ps/skype/New-CsTeamsMessagingPolicy.md rename to teams/teams-ps/teams/New-CsTeamsMessagingPolicy.md index 5ffa9a166f..f25c5317c1 100644 --- a/skype/skype-ps/skype/New-CsTeamsMessagingPolicy.md +++ b/teams/teams-ps/teams/New-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/new-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/new-csteamsmessagingpolicy +applicable: Microsoft Teams title: New-CsTeamsMessagingPolicy schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: --- # New-CsTeamsMessagingPolicy @@ -17,35 +13,177 @@ The CsTeamsMessagingPolicy cmdlets enable administrators to control if a user is ## 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] ] - [-CreateCustomEmojis ] [-DeleteCustomEmojis ] +```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. - +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 +```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. @@ -61,8 +199,9 @@ 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. +### -AllowGiphyDisplay + +Determines if Giphy images should be displayed that had been already sent or received in chat. Possible values: True, False ```yaml Type: Boolean @@ -76,8 +215,24 @@ 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. +### -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 @@ -111,6 +266,21 @@ Determines whether owners are allowed to delete all the messages in their team. 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 @@ -124,6 +294,82 @@ 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. @@ -139,6 +385,22 @@ 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. @@ -154,6 +416,22 @@ 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. @@ -199,13 +477,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -AllowVideoMessages + +This setting determines if users can create and send video messages. Possible values: True, False ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -214,11 +493,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Provide a description of your policy to identify purpose of creating it. +### -AudioMessageEnabledType +Determines whether a user is allowed to send audio messages. Possible values are: ChatsAndChannels,ChatsOnly,Disabled. ```yaml -Type: String +Type: AudioMessageEnabledTypeEnum Parameter Sets: (All) Aliases: @@ -229,11 +508,13 @@ 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. +### -ChannelsInChatListEnabledType +On mobile devices, enable to display favorite channels above recent chats. + +Possible values are: DisabledUserOverride,EnabledUserOverride. ```yaml -Type: SwitchParameter +Type: ChannelsInChatListEnabledTypeEnum Parameter Sets: (All) Aliases: @@ -244,8 +525,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. +### -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 @@ -254,31 +535,31 @@ Aliases: Required: False Position: Named -Default value: None +Default value: Restricted Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique identifier for the teams messaging policy to be created. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False -Position: 1 +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-. +### -CreateCustomEmojis +This setting enables the creation of custom emojis and reactions within an organization for the specified policy users. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: @@ -289,17 +570,26 @@ 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: +### -DeleteCustomEmojis +These settings enable and disable the editing and deletion of custom emojis and reactions for the users included in the messaging policy. --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: -You can return your tenant ID by running this command: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -Get-CsTenant | Select-Object DisplayName, TenantID +### -Description +Allows you to provide a description of your policy to note the purpose of creating it. ```yaml -Type: Guid +Type: String Parameter Sets: (All) Aliases: @@ -310,13 +600,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelsInChatListEnabledType -On mobile devices, enable to display favorite channels above recent chats. +### -DesignerForBackgroundsAndImages -Possible values are: DisabledUserOverride,EnabledUserOverride. +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: ChannelsInChatListEnabledTypeEnum +Type: String Parameter Sets: (All) Aliases: @@ -327,11 +618,11 @@ 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. +### -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: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -342,11 +633,11 @@ 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. +### -GiphyRatingType +Determines the Giphy content restrictions applicable to a user. Set this to STRICT, MODERATE or NORESTRICTION. ```yaml -Type: AudioMessageEnabledTypeEnum +Type: String Parameter Sets: (All) Aliases: @@ -357,11 +648,11 @@ 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. +### -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: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -372,26 +663,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSmartReply -Turn this setting on to enable suggested replies for chat messages. +### -InOrganizationChatControl + +This setting determines if chat regulation for internal communication in the tenant is allowed. ```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 ``` -### -AllowPriorityMessages -Determines whether a user is allowed to send priorities messages. Set this to TRUE to allow. Set this FALSE to prohibit. +### -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: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -402,14 +695,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -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: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -417,40 +715,46 @@ 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. + +### -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: String +Type: Boolean Parameter Sets: (All) Aliases: Required: False 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 ### None - ## OUTPUTS ### System.Object @@ -458,3 +762,10 @@ Accept wildcard characters: False ## 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 87% rename from skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md rename to teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md index 6f8e19956a..8bd31ac80b 100644 --- a/skype/skype-ps/skype/New-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsMobilityPolicy.md @@ -1,178 +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] ] [-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](/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 +--- +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 index 743ebf74f2..1b61b77f9d 100644 --- a/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsSharedCallingRoutingPolicy.md @@ -3,10 +3,11 @@ external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: +author: serdarsoysal +ms.author: serdars +ms.reviewer: manager: +title: New-CsTeamsSharedCallingRoutingPolicy schema: 2.0.0 --- @@ -49,7 +50,7 @@ The command shown in Example 1 gets the identity and phone number assigned to th ## PARAMETERS ### -Identity -Unique identifier of the Teams shared calling routing policy to be created. +Unique identifier of the Teams shared calling routing policy to be created. ```yaml Type: String @@ -106,10 +107,10 @@ The Identity of the resource account. Can only be specified using the Identity o 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](Set-CsPhoneNumberAssignment.md) and the -LocationId parameter to set the location. +- 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. +The same resource account can be used in multiple shared calling policy instances. ```yaml Type: String @@ -180,21 +181,21 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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](/microsoftteams/phone-reference/manage-numbers/contact-tns-service-desk). +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. +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](/microsoftteams/phone-reference/manage-numbers/contact-tns-service-desk). +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](Set-CsTeamsSharedCallingRoutingPolicy.md) +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) -[Grant-CsTeamsSharedCallingRoutingPolicy](Grant-CsTeamsSharedCallingRoutingPolicy.md) +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) -[Remove-CsTeamsSharedCallingRoutingPolicy](Remove-CsTeamsSharedCallingRoutingPolicy.md) +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) -[Get-CsTeamsSharedCallingRoutingPolicy](Get-CsTeamsSharedCallingRoutingPolicy.md) +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) -[Set-CsPhoneNumberAssignment](Set-CsPhoneNumberAssignment.md) +[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 index 5d2326e1bb..f09cf35e77 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnection.md @@ -2,8 +2,8 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: New-CsTeamsShiftsConnection -author: shane-malone -ms.author: shanemalone +author: serdarsoysal +ms.author: serdars manager: valk online version: https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection schema: 2.0.0 @@ -17,12 +17,12 @@ 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] [] ``` @@ -324,6 +324,21 @@ 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). @@ -341,12 +356,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) -[Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) -[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-CsTeamsShiftsConnectionBatchTeamMap.md b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionBatchTeamMap.md index 177eff0771..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 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](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,4 +97,4 @@ Please check the example section for the format of TeamMap. ## RELATED LINKS -[Get-CsTeamsShiftsConnectionOperation](Get-CsTeamsShiftsConnectionOperation.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 11fffa076f..9570c08ad4 100644 --- a/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/New-CsTeamsShiftsConnectionInstance.md @@ -31,7 +31,6 @@ This cmdlet creates a Shifts connection instance. It allows the admin to set up ## EXAMPLES - ### Example 1 ```powershell @@ -83,7 +82,6 @@ PS C:\> $result.ToJsonString() } ``` - Returns the object of created connector instance. In case of an error, we can capture the error response as follows: @@ -158,7 +156,7 @@ Accept wildcard characters: False ``` ### -ConnectionId -Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). +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 @@ -454,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-CsTeamsShiftsPolicy.md b/teams/teams-ps/teams/New-CsTeamsShiftsPolicy.md index 41283a4f4b..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,16 +14,16 @@ This cmdlet allows you to create a new TeamsShiftPolicy instance and set it's pr ## SYNTAX -``` -New-CsTeamsShiftsPolicy [-Identity] - [-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, and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - ## EXAMPLES ### Example 1 @@ -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) @@ -90,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. @@ -101,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) @@ -159,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 @@ -170,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 index 4399204703..88462d4a72 100644 --- a/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsTemplatePermissionPolicy.md @@ -5,7 +5,7 @@ online version: https://learn.microsoft.com/powershell/module/teams/new-csteamst title: New-CsTeamsTemplatePermissionPolicy author: yishuaihuang4 ms.author: yishuaihuang -ms.reviewer: +ms.reviewer: manager: weiliu2 schema: 2.0.0 --- @@ -24,7 +24,7 @@ New-CsTeamsTemplatePermissionPolicy ``` ## 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](Get-CsTeamTemplateList.md). +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 @@ -97,7 +97,7 @@ Accept wildcard characters: False ### -HiddenTemplates The list of Teams template IDs to hide. -The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](New-CsTeamsHiddenTemplate.md). +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] @@ -156,8 +156,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsTemplatePermissionPolicy](Get-CsTeamsTemplatePermissionPolicy.md) +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) -[Remove-CsTeamsTemplatePermissionPolicy](Remove-CsTeamsTemplatePermissionPolicy.md) +[Remove-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamstemplatepermissionpolicy) -[Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) +[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 87% rename from skype/skype-ps/skype/New-CsTeamsTranslationRule.md rename to teams/teams-ps/teams/New-CsTeamsTranslationRule.md index 7fecc8f36b..e760bec361 100644 --- a/skype/skype-ps/skype/New-CsTeamsTranslationRule.md +++ b/teams/teams-ps/teams/New-CsTeamsTranslationRule.md @@ -1,202 +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 - -### 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](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 index e306d84592..e231df2c8c 100644 --- a/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/teams/New-CsTeamsVirtualAppointmentsPolicy.md @@ -2,6 +2,7 @@ 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 @@ -30,8 +31,8 @@ Creates a new instance of the TeamsVirtualAppointmentsPolicy. This policy can be PS C:\> New-CsTeamsVirtualAppointmentsPolicy -Identity sms-enabled ``` ```output -Identity EnableSmsNotifications --------- ---------------------- +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. @@ -41,8 +42,8 @@ Creates a new policy instance with the identity enable-sms. `EnableSmsNotificati PS C:\> New-CsTeamsVirtualAppointmentsPolicy -Identity disable-sms -EnableSmsNotifications $false ``` ```output -Identity EnableSmsNotifications --------- ---------------------- +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. @@ -139,10 +140,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md) +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) -[Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md) +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) -[Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md) +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) -[Grant-CsTeamsVirtualAppointmentsPolicy](Grant-CsTeamsVirtualAppointmentsPolicy.md) +[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 358bee9d5e..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 --- @@ -14,38 +15,38 @@ Creates a new Teams voice applications policy. `TeamsVoiceApplications` policy g ## SYNTAX -``` -New-CsTeamsVoiceApplicationsPolicy [-Identity] +```powershell +New-CsTeamsVoiceApplicationsPolicy [-Identity] [-AllowAutoAttendantBusinessHoursGreetingChange ] [-AllowAutoAttendantAfterHoursGreetingChange ] [-AllowAutoAttendantHolidayGreetingChange ] [-AllowAutoAttendantBusinessHoursChange ] - [-AllowAutoAttendantHolidaysChange ] - [-AllowAutoAttendantTimeZoneChange ] - [-AllowAutoAttendantLanguageChange ] - [-AllowAutoAttendantBusinessHoursRoutingChange ] + [-AllowAutoAttendantHolidaysChange ] + [-AllowAutoAttendantTimeZoneChange ] + [-AllowAutoAttendantLanguageChange ] + [-AllowAutoAttendantBusinessHoursRoutingChange ] [-AllowAutoAttendantAfterHoursRoutingChange ] - [-AllowAutoAttendantHolidayRoutingChange ] - - [-AllowCallQueueWelcomeGreetingChange ] + [-AllowAutoAttendantHolidayRoutingChange ] + + [-AllowCallQueueWelcomeGreetingChange ] [-AllowCallQueueMusicOnHoldChange ] [-AllowCallQueueOverflowSharedVoicemailGreetingChange ] [-AllowCallQueueTimeoutSharedVoicemailGreetingChange ] [-AllowCallQueueNoAgentSharedVoicemailGreetingChange ] - [-AllowCallQueueLanguageChange ] - [-AllowCallQueueMembershipChange ] - [-AllowCallQueueConferenceModeChange ] - [-AllowCallQueueRoutingMethodChange ] + [-AllowCallQueueLanguageChange ] + [-AllowCallQueueMembershipChange ] + [-AllowCallQueueConferenceModeChange ] + [-AllowCallQueueRoutingMethodChange ] [-AllowCallQueuePresenceBasedRoutingChange ] - [-AllowCallQueueOptOutChange ] + [-AllowCallQueueOptOutChange ] [-AllowCallQueueOverflowRoutingChange ] - [-AllowCallQueueTimeoutRoutingChange ] + [-AllowCallQueueTimeoutRoutingChange ] [-AllowCallQueueNoAgentsRoutingChange ] - [-AllowCallQueueAgentOptChange ] - + [-AllowCallQueueAgentOptChange ] + [-CallQueueAgentMonitorMode ] [-CallQueueAgentMonitorNotificationMode ] - + [-RealTimeAutoAttendantMetricsPermission ] [-RealTimeCallQueueMetricsPermission ] [-RealTimeAgentMetricsPermission ] @@ -53,8 +54,9 @@ New-CsTeamsVoiceApplicationsPolicy [-Identity] [-HistoricalAutoAttendantMetricsPermission ] [-HistoricalCallQueueMetricsPermission ] [-HistoricalAgentMetricsPermission ] - - [-WhatIf] + + [-Description ] + [-WhatIf] [-Confirm] [] ``` @@ -76,7 +78,7 @@ The command shown in Example 1 creates a new per-user Teams voice applications p ### 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. @@ -181,6 +183,8 @@ Accept wildcard characters: False ### -AllowAutoAttendantTimeZoneChange +_This feature is not currently available to authorized users._ + When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. ```yaml @@ -197,6 +201,8 @@ Accept wildcard characters: False ### -AllowAutoAttendantLanguageChange +_This feature is not currently available to authorized users._ + When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. ```yaml @@ -325,6 +331,8 @@ Accept wildcard characters: False ### -AllowCallQueueNoAgentSharedVoicemailGreetingChange +_This option is not currently available in Queues app._ + When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. ```yaml @@ -341,6 +349,8 @@ Accept wildcard characters: False ### -AllowCallQueueLanguageChange +_This feature is not currently available to authorized users._ + When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. ```yaml @@ -487,8 +497,6 @@ Accept wildcard characters: False 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. -Note that the call queue must be configured to allow agents to opt out in order for this option to work. - ```yaml Type: Boolean Parameter Sets: (All) @@ -519,7 +527,7 @@ When set to `Takeover`, users affected by the policy will be allowed to monitor Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -540,7 +548,7 @@ When set to `Agent`, users affected by the policy will be allowed to monitor age Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -556,14 +564,15 @@ 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 `All`, users affected by the policy will receive real-time metrics for all auto attendants in the organization. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` won't be able to access real-time metrics. ```yaml Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -571,7 +580,7 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - + ### -RealTimeCallQueueMetricsPermission PARAMVALUE: Disabled | AuthorizedOnly | All @@ -579,14 +588,15 @@ PARAMVALUE: Disabled | AuthorizedOnly | All When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. - -When set to `All`, users affected by the policy will receive real-time metrics for all call queues in the organization. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` won't be able to access real-time metrics. ```yaml Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -602,14 +612,15 @@ 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. - -When set to `All`, users affected by the policy will receive real-time metrics for all agents in all call queues in the organization. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved, however, any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` won't be able to access real-time metrics. ```yaml Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -625,14 +636,14 @@ PARAMVALUE: Disabled | AuthorizedOnly | All When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for auto attendants. When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for auto attendants they are authorized for. - + When set to `All`, users affected by the policy will receive historical metrics for all auto attendants in the organization. ```yaml Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -640,7 +651,7 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - + ### -HistoricalCallQueueMetricsPermission PARAMVALUE: Disabled | AuthorizedOnly | All @@ -648,14 +659,14 @@ PARAMVALUE: Disabled | AuthorizedOnly | All When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for call queues they are authorized for. - + When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. ```yaml Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -671,14 +682,14 @@ 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: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -720,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). @@ -734,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 82% rename from skype/skype-ps/skype/New-CsTenantDialPlan.md rename to teams/teams-ps/teams/New-CsTenantDialPlan.md index e7aa8c7449..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 +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: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -27,7 +27,7 @@ You can use this cmdlet to create a new tenant dial plan. Tenant dial plans prov 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. -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 @@ -57,7 +57,7 @@ The value should not begin with a (.) ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: True @@ -90,7 +90,7 @@ Maximum characters: 1040. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -102,18 +102,18 @@ 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: +Aliases: Applicable: Microsoft Teams Required: False @@ -136,7 +136,7 @@ However, if you don't provide a value, a default value matching the Identity of ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -164,7 +164,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 @@ -176,10 +176,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) -[Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) -[Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) -[Remove-CsTenantDialPlan](Remove-CsTenantDialPlan.md) +[Remove-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/remove-cstenantdialplan) diff --git a/skype/skype-ps/skype/New-CsTenantNetworkRegion.md b/teams/teams-ps/teams/New-CsTenantNetworkRegion.md similarity index 86% rename from skype/skype-ps/skype/New-CsTenantNetworkRegion.md rename to teams/teams-ps/teams/New-CsTenantNetworkRegion.md index dd7aba9ac0..33bb7d2c2d 100644 --- a/skype/skype-ps/skype/New-CsTenantNetworkRegion.md +++ b/teams/teams-ps/teams/New-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/new-cstenantnetworkregion +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion applicable: Microsoft Teams title: New-CsTenantNetworkRegion schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -150,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,11 +159,12 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) -[Remove-CsTenantNetworkRegion](Remove-CsTenantNetworkRegion.md) +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) -[Set-CsTenantNetworkRegion](Set-CsTenantNetworkRegion.md) +[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 90% rename from skype/skype-ps/skype/New-CsTenantNetworkSite.md rename to teams/teams-ps/teams/New-CsTenantNetworkSite.md index 17d25a61b5..81412644a9 100644 --- a/skype/skype-ps/skype/New-CsTenantNetworkSite.md +++ b/teams/teams-ps/teams/New-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/new-cstenantnetworksite +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite applicable: Microsoft Teams title: New-CsTenantNetworkSite schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -97,7 +97,7 @@ 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). +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 @@ -186,7 +186,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -NetworkSiteID The name of the network site. This must be a string that is unique. You cannot specify an NetworkSiteID and an Identity at the same time. @@ -249,8 +248,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 @@ -259,8 +257,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md) +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) -[Remove-CsTenantNetworkSite](Remove-CsTenantNetworkSite.md) +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) -[Set-CsTenantNetworkSite](Set-CsTenantNetworkSite.md) +[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 89% rename from skype/skype-ps/skype/New-CsTenantNetworkSubnet.md rename to teams/teams-ps/teams/New-CsTenantNetworkSubnet.md index 567171f609..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 +online version: https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet applicable: Microsoft Teams title: New-CsTenantNetworkSubnet schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -71,7 +71,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -MaskBits This parameter determines the length of bits to mask to the subnet. @@ -89,7 +88,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -Description Provide a description of the network subnet to identify the purpose of creating it. @@ -167,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 @@ -179,8 +176,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md) +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) -[Remove-CsTenantNetworkSubnet](Remove-CsTenantNetworkSubnet.md) +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) -[Set-CsTenantNetworkSubnet](Set-CsTenantNetworkSubnet.md) +[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 95% rename from skype/skype-ps/skype/New-CsVideoInteropServiceProvider.md rename to teams/teams-ps/teams/New-CsVideoInteropServiceProvider.md index 247ed924ae..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 @@ -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 2fb27168b6..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,7 +30,7 @@ New-Team -DisplayName [-Description ] [-MailNickName ] [-AllowCreateUpdateChannels ] [-AllowDeleteChannels ] [-AllowAddRemoveApps ] [-AllowCreateUpdateRemoveTabs ] [-AllowCreateUpdateRemoveConnectors ] [-AllowUserEditMessages ] [-AllowUserDeleteMessages ] [-AllowOwnerDeleteMessages ] - [-AllowTeamMentions ] [-AllowChannelMentions ] [-ShowInTeamsSearchAndSuggestions ] + [-AllowTeamMentions ] [-AllowChannelMentions ] [-ShowInTeamsSearchAndSuggestions ] [-RetainCreatedGroup ] [-AllowCreatePrivateChannels ] [] ``` @@ -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. @@ -499,8 +497,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 @@ -512,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 84% rename from skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md rename to teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md index d035711bcc..e2c1985c62 100644 --- a/skype/skype-ps/skype/Register-CsOnlineDialInConferencingServiceNumber.md +++ b/teams/teams-ps/teams/Register-CsOnlineDialInConferencingServiceNumber.md @@ -1,21 +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 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. - +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 @@ -34,7 +33,7 @@ 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 84% rename from skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md index 8c415612b7..e735cc0dc3 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsCallHoldPolicy.md @@ -1,132 +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: jenstr -author: jenstrier ---- - -# 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](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 2d70a91752..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-msft -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 index 422397d76a..8619d8cca2 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/teams/Remove-CsTeamsCustomBannerText.md @@ -1,17 +1,17 @@ --- 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 -online version: https://learn.microsoft.com/powershell/module/teams/Remove-CsTeamsCustomBannerText -schema: 2.0.0 --- # Remove-CsTeamsCustomBannerText ## SYNOPSIS -Enables administrators to remove a custom banner text configuration that is displayed when compliance recording bots start recording the call. +Enables administrators to remove a custom banner text configuration that is displayed when compliance recording bots start recording the call. ## SYNTAX @@ -52,7 +52,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 @@ -60,12 +59,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) -[New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) -[Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) +[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/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md similarity index 78% rename from skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md index d2cd708278..ac3f34c82e 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingBrandingPolicy.md @@ -1,11 +1,11 @@ --- 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-csteamsmeetingbrandingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Remove-CsTeamsMeetingBrandingPolicy -author: szymonkatraMSFT -ms.author: szymonkatra +author: serdarsoysal +ms.author: serdars ms.reviewer: manager: stanlythomas --- @@ -70,7 +70,7 @@ Suppresses any confirmation prompts that would otherwise be displayed before mak ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -97,6 +97,9 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-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 @@ -104,12 +107,12 @@ Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file +[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 index 7bb8bcf1a9..b813ff072b 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsMeetingTemplatePermissionPolicy.md @@ -16,7 +16,7 @@ Deletes an instance of TeamsMeetingTemplatePermissionPolicy. ## SYNTAX ```powershell -Remove-CsTeamsMeetingTemplatePermissionPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] +Remove-CsTeamsMeetingTemplatePermissionPolicy [-Identity] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -71,12 +71,17 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +## OUTPUTS + +## NOTES ## RELATED LINKS -[Set-CsTeamsMeetingTemplatePermissionPolicy](Set-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Set-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingtemplatepermissionpolicy) -[Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.yml) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) -[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.yml) +[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 index 542cd51ee2..536843d50b 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsSharedCallingRoutingPolicy.md @@ -3,11 +3,12 @@ external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Remove-CsTeamsSharedCallingRoutingPolicy schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: --- # Remove-CsTeamsSharedCallingRoutingPolicy @@ -116,10 +117,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable This cmdlet was introduced in Teams PowerShell Module 5.5.0. ## RELATED LINKS -[Get-CsTeamsSharedCallingRoutingPolicy](Get-CsTeamsSharedCallingRoutingPolicy.md) +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) -[Grant-CsTeamsSharedCallingRoutingPolicy](Grant-CsTeamsSharedCallingRoutingPolicy.md) +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) -[Set-CsTeamsSharedCallingRoutingPolicy](Set-CsTeamsSharedCallingRoutingPolicy.md) +[Set-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy) -[New-CsTeamsSharedCallingRoutingPolicy](New-CsTeamsSharedCallingRoutingPolicy.md) +[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 index a221b3aded..a86968dfd2 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Remove-CsTeamsShiftsConnection.md @@ -2,8 +2,8 @@ external help file: Microsoft.TeamsCmdlets.PowerShell.Custom.dll-Help.xml Module Name: MicrosoftTeams title: Remove-CsTeamsShiftsConnection -author: sofiamaniou -ms.author: somaniou +author: serdarsoysal +ms.author: serdars manager: stepfitz online version: https://learn.microsoft.com/powershell/module/teams/remove-csteamsshiftsconnection schema: 2.0.0 @@ -18,12 +18,12 @@ This cmdlet deletes a Shifts connection. ## SYNTAX ``` -Remove-CsTeamsShiftsConnection -ConnectionId [] +Remove-CsTeamsShiftsConnection -ConnectionId -InputObject [-PassThru] [] ``` ## DESCRIPTION -This cmdlet deletes a connection. All available connections can be found by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). +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 @@ -52,6 +52,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). @@ -63,8 +95,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) -[New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) +[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-CsTeamsShiftsConnectionBatchTeamMap](New-CsTeamsShiftsConnectionBatchTeamMap.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 index 6a6a1ac22d..28ecb18cd4 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsTemplatePermissionPolicy.md @@ -5,7 +5,7 @@ online version: https://learn.microsoft.com/powershell/module/teams/remove-cstea title: Remove-CsTeamsTemplatePermissionPolicy author: yishuaihuang4 ms.author: yishuaihuang -ms.reviewer: +ms.reviewer: manager: weiliu2 schema: 2.0.0 --- @@ -128,8 +128,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsTemplatePermissionPolicy](Get-CsTeamsTemplatePermissionPolicy.md) +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) -[New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) -[Set-CsTeamsTemplatePermissionPolicy](Set-CsTeamsTemplatePermissionPolicy.md) +[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 index 3cff45335b..a1a3852ec4 100644 --- a/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/teams/Remove-CsTeamsVirtualAppointmentsPolicy.md @@ -2,6 +2,7 @@ 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 @@ -108,10 +109,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md) +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) -[New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md) +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) -[Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md) +[Set-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/set-csteamsvirtualappointmentspolicy) -[Grant-CsTeamsVirtualAppointmentsPolicy](Grant-CsTeamsVirtualAppointmentsPolicy.md) +[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 80% rename from skype/skype-ps/skype/Remove-CsTenantDialPlan.md rename to teams/teams-ps/teams/Remove-CsTenantDialPlan.md index 748e6360b5..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 +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: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -39,7 +39,6 @@ Remove-CsTenantDialPlan -Identity Vt1TenantDialPlan2 This example removes the Vt1TenantDialPlan2. - ## PARAMETERS ### -Identity @@ -48,7 +47,7 @@ The Identity parameter is the unique identifier of the tenant dial plan to remov ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: True @@ -91,7 +90,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -103,10 +102,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) -[New-CsTenantDialPlan](New-CsTenantDialPlan.md) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) -[Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) +[Set-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/set-cstenantdialplan) -[Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) +[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 75% rename from skype/skype-ps/skype/Remove-CsTenantNetworkRegion.md rename to teams/teams-ps/teams/Remove-CsTenantNetworkRegion.md index f418cb1c57..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 +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion applicable: Microsoft Teams title: Remove-CsTenantNetworkRegion schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -83,19 +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 ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[New-CsTenantNetworkRegion](New-CsTenantNetworkRegion.md) +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) -[Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md) +[Get-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworkregion) -[Set-CsTenantNetworkRegion](Set-CsTenantNetworkRegion.md) +[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 77% rename from skype/skype-ps/skype/Remove-CsTenantNetworkSite.md rename to teams/teams-ps/teams/Remove-CsTenantNetworkSite.md index d5f253f803..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 +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite applicable: Microsoft Teams title: Remove-CsTenantNetworkSite schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -84,19 +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 ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[New-CsTenantNetworkSite](New-CsTenantNetworkSite.md) +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) -[Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md) +[Get-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksite) -[Set-CsTenantNetworkSite](Set-CsTenantNetworkSite.md) +[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 78% rename from skype/skype-ps/skype/Remove-CsTenantNetworkSubnet.md rename to teams/teams-ps/teams/Remove-CsTenantNetworkSubnet.md index 9543dd8eac..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 +online version: https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet applicable: Microsoft Teams title: Remove-CsTenantNetworkSubnet schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -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 @@ -94,8 +93,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsTenantNetworkSubnet](New-CsTenantNetworkSubnet.md) +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) -[Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md) +[Get-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/get-cstenantnetworksubnet) -[Set-CsTenantNetworkSubnet](Set-CsTenantNetworkSubnet.md) +[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/skype/skype-ps/skype/Set-CsCallQueue.md b/teams/teams-ps/teams/Set-CsCallQueue.md similarity index 58% rename from skype/skype-ps/skype/Set-CsCallQueue.md rename to teams/teams-ps/teams/Set-CsCallQueue.md index 792b8d9a39..8f93fc3973 100644 --- a/skype/skype-ps/skype/Set-CsCallQueue.md +++ b/teams/teams-ps/teams/Set-CsCallQueue.md @@ -1,13 +1,14 @@ --- 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 +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 -ms.author: tomkau author: tomkau +ms.author: tomkau +ms.reviewer: williamlooney --- # Set-CsCallQueue @@ -18,66 +19,68 @@ 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 ] [-NoAgentAction ] [-NoAgentActionTarget ] [-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 ] [] +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. +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. -> -> - -OverflowDisconnectTextToSpeechPrompt -> - -OverflowDisconnectAudioFilePrompt +> 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 -> - -OverflowRedirectVoiceAppTextToSpeechPrompt -> - -OverflowRedirectVoiceAppAudioFilePrompt -> - -OverflowRedirectPhoneNumberTextToSpeechPrompt -> - -OverflowRedirectPhoneNumberAudioFilePrompt > - -OverflowRedirectVoicemailTextToSpeechPrompt > - -OverflowRedirectVoicemailAudioFilePrompt -> - -TimeoutDisconnectTextToSpeechPrompt -> - -TimeoutDisconnectAudioFilePrompt +> - -TimeoutActionCallPriority > - -TimeoutRedirectPersonTextToSpeechPrompt > - -TimeoutRedirectPersonAudioFilePrompt -> - -TimeoutRedirectVoiceAppTextToSpeechPrompt -> - -TimeoutRedirectVoiceAppAudioFilePrompt -> - -TimeoutRedirectPhoneNumberTextToSpeechPrompt -> - -TimeoutRedirectPhoneNumberAudioFilePrompt > - -TimeoutRedirectVoicemailTextToSpeechPrompt > - -TimeoutRedirectVoicemailAudioFilePrompt -> - -NoAgentDisconnectTextToSpeechPrompt -> - -NoAgentDisconnectAudioFilePrompt +> - -NoAgentActionCallPriority > - -NoAgentRedirectPersonTextToSpeechPrompt > - -NoAgentRedirectPersonAudioFilePrompt -> - -NoAgentRedirectVoiceAppTextToSpeechPrompt -> - -NoAgentRedirectVoiceAppAudioFilePrompt -> - -NoAgentRedirectPhoneNumberTextToSpeechPrompt -> - -NoAgentRedirectPhoneNumberAudioFilePrompt > - -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 -------------------------- +### -------------------------- 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 -------------------------- +### -------------------------- 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) +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 @@ -87,8 +90,8 @@ PARAMVALUE: Guid ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -103,8 +106,8 @@ The AgentAlertTime parameter represents the time (in seconds) that a call can re ```yaml Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -119,8 +122,8 @@ The AllowOptOut parameter indicates whether or not agents can opt in or opt out ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -135,8 +138,8 @@ The DistributionLists parameter lets you add all the members of the distribution ```yaml Type: List Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -151,8 +154,8 @@ The MusicOnHoldFileContent parameter represents music to play when callers are p ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -167,8 +170,8 @@ The Name parameter specifies a unique name for the Call Queue. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -183,8 +186,8 @@ The OboResourceAccountIds parameter lets you add resource account with phone num ```yaml Type: List Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -201,8 +204,8 @@ PARAMVALUE: DisconnectWithBusy | Forward | Voicemail | SharedVoicemail ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -217,8 +220,36 @@ The OverflowActionTarget parameter represents the target of the overflow action. ```yaml Type: String 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 +``` + +### -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 @@ -233,8 +264,8 @@ The OverflowThreshold parameter defines the number of calls that can be in the q ```yaml Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -251,8 +282,8 @@ PARAMVALUE: Attendant | Serial | RoundRobin | LongestIdle ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -269,8 +300,8 @@ PARAMVALUE: Disconnect | Forward | Voicemail | SharedVoicemail ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -285,8 +316,36 @@ The TimeoutActionTarget represents the target of the timeout action. If the Time ```yaml Type: String 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 +``` + +### -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 @@ -296,14 +355,14 @@ 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 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 +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -312,6 +371,24 @@ 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. @@ -320,8 +397,8 @@ PARAMVALUE: Queue | Disconnect | Forward | Voicemail | SharedVoicemail ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -336,8 +413,36 @@ The NoAgentActionTarget represents the target of the no agent action. If the NoA ```yaml Type: String 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 +``` + +### -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 @@ -352,8 +457,8 @@ The UseDefaultMusicOnHold parameter indicates that this Call Queue uses the defa ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -368,8 +473,8 @@ The WelcomeMusicAudioFileId parameter represents the audio file to play when cal ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -384,8 +489,8 @@ The PresenceBasedRouting parameter indicates whether or not presence based routi ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -404,8 +509,8 @@ The ConferenceMode parameter indicates whether or not Conference mode will be ap ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -420,8 +525,8 @@ The User parameter lets you add agents to the Call Queue. This parameter expects ```yaml Type: List Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -436,8 +541,8 @@ This parameter is reserved for Microsoft internal use only. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -454,8 +559,8 @@ You can query the supported languages using the Get-CsAutoAttendantSupportedLang ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -470,8 +575,8 @@ This parameter is reserved for Microsoft internal use only. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -486,8 +591,8 @@ The OverflowDisconnectAudioFilePrompt parameter indicates the unique identifier ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -497,13 +602,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -513,13 +618,15 @@ Accept wildcard characters: False ``` ### -OverflowRedirectPersonAudioFilePrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -529,13 +636,15 @@ Accept wildcard characters: False ``` ### -OverflowRedirectPersonTextToSpeechPrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -545,13 +654,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -561,13 +670,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -577,13 +686,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -593,13 +702,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -609,13 +718,15 @@ Accept wildcard characters: False ``` ### -OverflowRedirectVoicemailAudioFilePrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -625,13 +736,15 @@ Accept wildcard characters: False ``` ### -OverflowRedirectVoicemailTextToSpeechPrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -646,8 +759,8 @@ The OverflowSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Sp ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -662,8 +775,8 @@ The OverflowSharedVoicemailAudioFilePrompt parameter indicates the unique identi ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -678,8 +791,8 @@ The EnableOverflowSharedVoicemailTranscription parameter is used to turn on tran ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -694,8 +807,8 @@ The EnableOverflowSharedVoicemailSystemPromptSuppress parameter is used to turn ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -710,8 +823,8 @@ The TimeoutDisconnectAudioFilePrompt parameter indicates the unique identifier f ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -721,13 +834,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -737,13 +850,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -753,13 +866,15 @@ Accept wildcard characters: False ``` ### -TimeoutRedirectPersonTextToSpeechPrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -769,13 +884,15 @@ 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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -785,13 +902,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -801,13 +918,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -817,13 +934,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -833,13 +950,15 @@ Accept wildcard characters: False ``` ### -TimeoutRedirectVoicemailAudioFilePrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -849,13 +968,15 @@ Accept wildcard characters: False ``` ### -TimeoutRedirectVoicemailTextToSpeechPrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -870,8 +991,8 @@ The TimeoutSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Spe ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -886,8 +1007,8 @@ The TimeoutSharedVoicemailAudioFilePrompt parameter indicates the unique identif ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -902,8 +1023,8 @@ The EnableTimeoutSharedVoicemailTranscription parameter is used to turn on trans ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -918,8 +1039,8 @@ The EnableTimeoutSharedVoicemailSystemPromptSuppression parameter is used to tur ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -929,13 +1050,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -950,8 +1071,8 @@ The NoAgentDisconnectAudioFilePrompt parameter indicates the unique identifier f ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -961,13 +1082,15 @@ Accept wildcard characters: False ``` ### -NoAgentRedirectPersonTextToSpeechPrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -977,13 +1100,15 @@ Accept wildcard characters: False ``` ### -NoAgentRedirectPersonAudioFilePrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -993,13 +1118,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1009,13 +1134,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1025,13 +1150,13 @@ 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. +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1040,14 +1165,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAgentsRedirectPhoneNumberAudioFilePrompt -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. +### -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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1057,13 +1182,15 @@ Accept wildcard characters: False ``` ### -NoAgentRedirectVoicemailTextToSpeechPrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1073,13 +1200,15 @@ Accept wildcard characters: False ``` ### -NoAgentRedirectVoicemailAudioFilePrompt -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. +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1094,8 +1223,8 @@ The NoAgentSharedVoicemailTextToSpeechPrompt parameter indicates the Text-to-Spe ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1110,8 +1239,8 @@ The NoAgentSharedVoicemailAudioFilePrompt parameter indicates the unique identif ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1126,8 +1255,8 @@ The EnableNoAgentSharedVoicemailTranscription parameter is used to turn on trans ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1142,8 +1271,8 @@ The EnableNoAgentSharedVoicemailSystemPromptSuppression parameter is used to tur ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1158,8 +1287,8 @@ Id of the channel to connect a call queue to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1174,8 +1303,48 @@ The GUID should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxx ```yaml Type: Guid 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 +``` + +### -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 @@ -1185,13 +1354,13 @@ 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). +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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1201,13 +1370,15 @@ Accept wildcard characters: False ``` ### -HideAuthorizedUsers -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). +_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: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -1231,6 +1402,301 @@ 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). @@ -1243,3 +1709,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 72% rename from skype/skype-ps/skype/Set-CsCallingLineIdentity.md rename to teams/teams-ps/teams/Set-CsCallingLineIdentity.md index 41dadc3d0b..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,21 +20,16 @@ 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 - -**Note**: The use of CallingIDSubstitute Service has been deprecated. Existing policies using CallingIDSubstitute Service are not being honored. You should use CallingIDSubstitute Resource instead. - You can either change or block the Caller ID (also called a Calling Line ID) for a user. 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 @@ -78,8 +73,8 @@ The BlockIncomingPstnCallerID switch is specific to incoming calls from a PSTN c ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -89,16 +84,14 @@ Accept wildcard characters: False ``` ### -CallingIDSubstitute -**Note**: The use of CallingIDSubstitute Service will be deprecated. You should start using CallingIDSubstitute Resource as soon as possible. - 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 @@ -114,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 @@ -129,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 @@ -149,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 @@ -165,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 @@ -182,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 @@ -218,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 @@ -234,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 @@ -244,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 @@ -253,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/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md b/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md similarity index 70% rename from skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md rename to teams/teams-ps/teams/Set-CsOnlineApplicationInstance.md index 30178d77b7..4e64fee3fa 100644 --- a/skype/skype-ps/skype/Set-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/teams/Set-CsOnlineApplicationInstance.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-csonlineapplicationinstance +online version: https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance applicable: Microsoft Teams title: Set-CsOnlineApplicationInstance schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- # Set-CsOnlineApplicationInstance ## SYNOPSIS -Updates an application instance in Microsoft Entra ID. +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](/powershell/module/teams/set-csphonenumberassignment) and [Remove-CsPhoneNumberAssignment](/powershell/module/teams/remove-csphonenumberassignment) cmdlets instead. +**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] ] [[-DisplayName] ] [-Force] [-WhatIf] [-Confirm] [] +Set-CsOnlineApplicationInstance [-Identity] [[-OnpremPhoneNumber] ] [[-ApplicationId] ] [[-AcsResourceId] ] [[-DisplayName] ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -87,6 +87,21 @@ 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. @@ -153,7 +168,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 @@ -163,10 +178,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) +[Get-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/get-csonlineapplicationinstance) -[New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) -[Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) +[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 87% rename from skype/skype-ps/skype/Set-CsOnlineDialInConferencingUser.md rename to teams/teams-ps/teams/Set-CsOnlineDialInConferencingUser.md index 24a44745af..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. @@ -26,7 +22,7 @@ Use the `Set-CsOnlineDialInConferencingUser` cmdlet to modify the properties of Set-CsOnlineDialInConferencingUser [-Identity] [-BridgeId ] [-BridgeName ] [-Tenant ] [-ServiceNumber ] [-TollFreeServiceNumber ] [-AllowPSTNOnlyMeetings ] [-Force] [-ResetLeaderPin] [-AllowTollFreeDialIn ] [-SendEmailToAddress ] - [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] [-SendEmail] [-DomainController ] + [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] [-SendEmail] [-DomainController ] [-AsJob] [-WhatIf] [-Confirm] [] ``` @@ -35,7 +31,7 @@ Set-CsOnlineDialInConferencingUser [-Identity] [-BridgeId [-BridgeId ] [-BridgeName ] [-TenantDomain ] [-ServiceNumber ] [-TollFreeServiceNumber ] [-AllowPSTNOnlyMeetings ] [-Force] [-ResetLeaderPin] [-AllowTollFreeDialIn ] [-SendEmailToAddress ] - [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] [-SendEmail] [-DomainController ] + [-SendEmailFromAddress ] [-SendEmailFromDisplayName ] [-SendEmail] [-DomainController ] [-AsJob] [-WhatIf] [-Confirm] [] ``` @@ -53,7 +49,6 @@ Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -ResetLeaderPin -Servi 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" @@ -61,7 +56,6 @@ Set-CsOnlineDialInConferencingUser -Identity "Ken Meyers" -BridgeName "Conferenc This example sets a user's conference bridge assignment. - ## PARAMETERS ### -Identity @@ -72,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 @@ -90,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 @@ -109,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 @@ -125,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 @@ -141,8 +135,8 @@ Specifies the name of the audio conferencing bridge. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -158,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 @@ -181,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 @@ -198,8 +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 +Aliases: +applicable: Microsoft Teams Required: False Position: Named @@ -214,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 @@ -230,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 @@ -246,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 @@ -262,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 @@ -278,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 @@ -298,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 84% rename from skype/skype-ps/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md rename to teams/teams-ps/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md index cdd8ed7bf1..289ee4575e 100644 --- a/skype/skype-ps/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md +++ b/teams/teams-ps/teams/Set-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/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 @@ -36,7 +36,6 @@ You must run this cmdlet prior to assigning Microsoft Calling Plan phone numbers 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 ### -------------------------- Example 1 -------------------------- @@ -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 38b9409756..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,7 +16,11 @@ ms.reviewer: Use the \`Set-CsOnlineLisCivicAddress\` cmdlet to modify an existing civic address which has not been validated. Validated civic addresses cannot be modified. -**Note:** This cmdlet is only available for Microsoft internal use. +> [!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 @@ -26,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. @@ -58,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 @@ -68,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 @@ -84,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 @@ -100,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 @@ -117,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 @@ -138,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 @@ -149,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 @@ -164,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 @@ -188,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 @@ -198,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 @@ -217,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 @@ -231,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 @@ -250,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 @@ -267,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 @@ -281,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 @@ -297,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 @@ -316,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 @@ -336,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 @@ -353,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 @@ -385,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 @@ -395,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 @@ -411,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 @@ -437,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 92% rename from skype/skype-ps/skype/Set-CsOnlineLisLocation.md rename to teams/teams-ps/teams/Set-CsOnlineLisLocation.md index eb8ce44596..d93fd56f49 100644 --- a/skype/skype-ps/skype/Set-CsOnlineLisLocation.md +++ b/teams/teams-ps/teams/Set-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/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: --- @@ -23,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 @@ -419,6 +419,22 @@ 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. @@ -481,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 96% rename from skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md rename to teams/teams-ps/teams/Set-CsOnlinePSTNGateway.md index 587d82c05a..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: --- @@ -410,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 @@ -423,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 74% rename from skype/skype-ps/skype/Set-CsOnlineVoiceApplicationInstance.md rename to teams/teams-ps/teams/Set-CsOnlineVoiceApplicationInstance.md index afc1370c02..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 Microsoft Entra ID. - -**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 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 -``` - -## 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 7daec3094f..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 @@ -38,12 +39,22 @@ Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumbe Set-CsPhoneNumberAssignment -Identity -EnterpriseVoiceEnabled [] ``` +### ReverseNumberLookup +```powershell +Set-CsPhoneNumberAssignment -PhoneNumber -ReverseNumberLookup [] +``` + +### Notify +```powershell +Set-CsPhoneNumberAssignment -Identity -PhoneNumber -PhoneNumberType -Notify [] +``` + ## DESCRIPTION This cmdlet assigns a phone number to a user or resource account. When you assign a phone number the EnterpriseVoiceEnabled flag is automatically set to True. You can also assign a location to a phone number. -To remove a phone number from a user or resource account, use the [Remove-CsPhoneNumberAssignment](Remove-CsPhoneNumberAssignment.md) cmdlet. +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 @@ -86,7 +97,7 @@ This example assigns the Direct Routing phone number +1 (425) 555-1000;ext=1234 ### Example 7 ```powershell -Try { Set-CsPhoneNumberAssignment -Identity user5@contoso.com -PhoneNumber "+14255551000;ext=1234" -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. @@ -122,8 +133,8 @@ 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 { + } + Catch { Write-Host Could not update $pn.TelephoneNumber with location $NewLocationId } } @@ -132,16 +143,32 @@ Write-Host (Get-CsPhoneNumberAssignment -LocationId $NewLocationId).Count number ``` 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 is reserved for internal Microsoft use. +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: +Aliases: Applicable: Microsoft Teams Required: False @@ -158,7 +185,7 @@ This parameter is mutual exclusive with PhoneNumber. ```yaml Type: System.Boolean Parameter Sets: (Attribute) -Aliases: +Aliases: Applicable: Microsoft Teams Required: True @@ -186,7 +213,7 @@ Accept wildcard characters: False 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 @@ -206,7 +233,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: System.String Parameter Sets: (Assignment) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -216,7 +243,7 @@ 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 or resource account. @@ -247,6 +274,35 @@ 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 +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -269,6 +325,6 @@ The previous command for assigning phone numbers to users Set-CsUser had the par 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 c5e7294462..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 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](/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 @@ -80,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). @@ -91,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/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md b/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md similarity index 92% rename from skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md index ee6832ec92..58ff1553f7 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppPermissionPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsAppPermissionPolicy.md @@ -1,330 +1,319 @@ ---- -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 - -```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 +--- +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/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md b/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md similarity index 71% rename from skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md index 01bf6abe26..1e6e8b5c3a 100644 --- a/skype/skype-ps/skype/Set-CsTeamsAppSetupPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsAppSetupPolicy.md @@ -1,13 +1,9 @@ --- 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 +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsappsetuppolicy +applicable: Microsoft Teams title: Set-CsTeamsAppSetupPolicy schema: 2.0.0 -manager: bulenteg -author: tomkau -ms.author: tomkau -ms.reviewer: --- # Set-CsTeamsAppSetupPolicy @@ -22,15 +18,41 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ## SYNTAX ### Identity (Default) -``` -Set-CsTeamsAppSetupPolicy [-Tenant ] [-PinnedAppBarApps <>] [-Description ] - [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] +```powershell +Set-CsTeamsAppSetupPolicy [[-Identity] ] + [-AllowSideLoading ] + [-AllowUserPinning ] + [-AppPresetList ] + [-Confirm] + [-Description ] + [-Force] + [-PinnedAppBarApps ] + [-PinnedCallingBarApps ] + [-PinnedMessageBarApps ] + [-AppPresetMeetingList ] + [-AdditionalCustomizationApps ] + [-Tenant ] + [-WhatIf] + [] ``` ### Instance -``` -Set-CsTeamsAppSetupPolicy [-Tenant ] [-PinnedAppBarApps <>] [-Description ] - [-Instance ] [-Force] [-WhatIf] [-Confirm] [] +```powershell +Set-CsTeamsAppSetupPolicy [-Instance ] + [-AllowSideLoading ] + [-AllowUserPinning ] + [-AppPresetList ] + [-Confirm] + [-Description ] + [-Force] + [-PinnedAppBarApps ] + [-PinnedCallingBarApps ] + [-PinnedMessageBarApps ] + [-AppPresetMeetingList ] + [-AdditionalCustomizationApps ] + [-Tenant ] + [-WhatIf] + [] ``` ## DESCRIPTION @@ -47,8 +69,9 @@ Apps are pinned to the app bar. This is the bar on the side of the Teams desktop ```powershell # Create new teams app setup policy named "Set-Test". New-CsTeamsAppSetupPolicy -Identity 'Set-Test' -Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -AllowUserPinning $true -AllowSideLoading $false +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. @@ -62,6 +85,7 @@ $TeamsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.C $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. @@ -74,6 +98,7 @@ $VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration $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. @@ -86,19 +111,50 @@ $VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administratio $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 -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Identity +Name of app setup policy. If empty, all identities will be used by default. ```yaml -Type: SwitchParameter +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: cf +Aliases: Required: False Position: Named @@ -107,11 +163,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Description of App setup policy. +### -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: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -122,11 +178,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Do not use. +### -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: SwitchParameter +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[] Parameter Sets: (All) Aliases: @@ -137,41 +193,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Name of app setup policy. If empty, all identities will be used by default. +### -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: XdsIdentity -Parameter Sets: Identity +Type: System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] +Parameter Sets: (All) Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Do not use. +### -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: PSObject -Parameter Sets: Instance +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: True (ByValue) +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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Boolean +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: @@ -182,11 +253,11 @@ 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. +### -Force +Do not use. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -212,11 +283,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PinnedMessageBarApps -Apps will be pinned in messaging extensions and into the ellipsis menu. +### -PinnedCallingBarApps +Determines the list of apps that are pre pinned for a participant in Calls. ```yaml -Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[] Parameter Sets: (All) Aliases: @@ -227,11 +298,11 @@ 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. +### -PinnedMessageBarApps +Apps will be pinned in messaging extensions and into the ellipsis menu. ```yaml -Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[] +Type: Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] Parameter Sets: (All) Aliases: @@ -274,8 +345,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 @@ -285,7 +355,6 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ### Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp - ## OUTPUTS ### System.Object 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 85% rename from skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md index fce74050c6..27aaba2f36 100644 --- a/skype/skype-ps/skype/Set-CsTeamsCallHoldPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsCallHoldPolicy.md @@ -1,203 +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: jenstr -author: jenstrier ---- - -# 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](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/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md similarity index 71% rename from skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsCallingPolicy.md index 9b69ab1071..1f3a0f0fe7 100644 --- a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsCallingPolicy.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/set-csteamscallingpolicy +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: jenstrier -ms.author: jenstr -ms.reviewer: +author: serdarsoysal +ms.author: serdars +ms.reviewer: alejandramu --- # Set-CsTeamsCallingPolicy @@ -19,15 +19,41 @@ Use this cmdlet to update values in existing Teams Calling Policies. ## SYNTAX ### Identity (Default) -``` -Set-CsTeamsCallingPolicy [-Identity] [-AllowPrivateCalling ] [-AllowWebPSTNCalling ] - [-AllowSIPDevicesCalling ] [-AllowVoicemail ] [-AllowCallGroups ] [-AllowDelegation ] - [-AllowCallForwardingToUser ] [-AllowCallForwardingToPhone ] [-PreventTollBypass ] - [-BusyOnBusyEnabledType ] [-MusicOnHoldEnabledType ] [-AllowCloudRecordingForCalls ] - [-AllowTranscriptionForCalling ] [-PopoutForIncomingPstnCalls ] [-PopoutAppPathForIncomingPstnCalls ] - [-LiveCaptionsEnabledTypeForCalling ] [-AutoAnswerEnabledType ] [-SpamFilteringEnabledType ] - [-CallRecordingExpirationDays ] [-AllowCallRedirect ] - [-InboundPstnCallRoutingTreatment ] [-InboundFederatedCallRoutingTreatment ] [-Force] [-WhatIf] [-Confirm] [] +```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 @@ -54,6 +80,45 @@ Sets the value of the parameter LiveCaptionsEnabledTypeForCalling to Disabled in ## 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. @@ -106,6 +171,7 @@ Accept wildcard characters: False 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. @@ -205,9 +271,10 @@ Accept wildcard characters: False ``` ### -AllowVoicemail -Enables inbound calls to be routed to voicemail. +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. @@ -242,21 +309,17 @@ 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. +Allow admins to enable or disable Auto-answer settings for users. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named -Default value: Disabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -265,6 +328,7 @@ Accept wildcard characters: False 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. @@ -283,6 +347,24 @@ 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. @@ -299,6 +381,43 @@ 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. @@ -315,25 +434,64 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Name of the policy instance being created. +### -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: String +Type: Boolean Parameter Sets: (All) Aliases: +Applicable: Microsoft Teams Required: False -Position: 1 +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. +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. @@ -354,13 +512,14 @@ Accept wildcard characters: False ``` ### -InboundPstnCallRoutingTreatment -Setting this parameter lets you control how inbound PSTN calls should be routed. +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. +- 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. @@ -381,8 +540,9 @@ Accept wildcard characters: False 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: Prohibts the user from turning on live captions. +- Disabled: Prohibits the user from turning on live captions. ```yaml Type: String @@ -398,9 +558,10 @@ 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. +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. @@ -449,9 +610,10 @@ 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. +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. +> [!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 @@ -470,6 +632,7 @@ Accept wildcard characters: False 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. @@ -486,46 +649,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -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: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: Disabled Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -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: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Applicable: Microsoft Teams Required: False Position: Named -Default value: False +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Applicable: Microsoft Teams Required: False @@ -550,10 +729,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsCallingPolicy](Get-CsTeamsCallingPolicy.md) +[Get-CsTeamsCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-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/Set-CsTeamsChannelsPolicy.md b/teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md similarity index 81% rename from skype/skype-ps/skype/Set-CsTeamsChannelsPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsChannelsPolicy.md index 1b7e942000..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 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](/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 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](/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 94% rename from skype/skype-ps/skype/Set-CsTeamsClientConfiguration.md rename to teams/teams-ps/teams/Set-CsTeamsClientConfiguration.md index 13bab70a3a..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 @@ -394,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 90% rename from skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md index 51d43358e2..482a4c801b 100644 --- a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsComplianceRecordingPolicy.md @@ -1,361 +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 ] [-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 - -## 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 b832287e5e..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-msft -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 index 471c3a2766..131dd52c2a 100644 --- a/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md +++ b/teams/teams-ps/teams/Set-CsTeamsCustomBannerText.md @@ -1,17 +1,17 @@ --- 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 -online version: https://learn.microsoft.com/powershell/module/teams/Set-CsTeamsCustomBannerText -schema: 2.0.0 --- # Set-CsTeamsCustomBannerText ## SYNOPSIS -Enables administrators to update a configured custom text on the banner displayed when compliance recording bots start recording the call. +Enables administrators to update a configured custom text on the banner displayed when compliance recording bots start recording the call. ## SYNTAX @@ -74,7 +74,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 @@ -82,12 +81,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Set-CsTeamsCustomBannerText](Set-CsTeamsCustomBannerText.md) +[Set-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/set-csteamscustombannertext) -[New-CsTeamsCustomBannerText](New-CsTeamsCustomBannerText.md) +[New-CsTeamsCustomBannerText](https://learn.microsoft.com/powershell/module/teams/new-csteamscustombannertext) -[Remove-CsTeamsCustomBannerText](Remove-CsTeamsCustomBannerText.md) +[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/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md similarity index 67% rename from skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsEmergencyCallingPolicy.md index e20fd12cb9..b67d6b3cd5 100644 --- a/skype/skype-ps/skype/Set-CsTeamsEmergencyCallingPolicy.md +++ b/teams/teams-ps/teams/Set-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/set-csteamsemergencycallingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsemergencycallingpolicy applicable: Microsoft Teams title: Set-CsTeamsEmergencyCallingPolicy -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars manager: roykuntz ms.reviewer: chenc schema: 2.0.0 @@ -19,9 +19,9 @@ schema: 2.0.0 ### Identity (Default) ``` Set-CsTeamsEmergencyCallingPolicy [-Identity] [-ExtendedNotifications ] - [-NotificationGroup ] [-NotificationDialOutNumber ] [-ExternalLocationLookupMode ] - [-NotificationMode ] [-EnhancedEmergencyServiceDisclaimer ] - [-Description ] [-Force] [-WhatIf] [-Confirm] [] + [-NotificationGroup ] [-NotificationDialOutNumber ] [-ExternalLocationLookupMode ] + [-NotificationMode ] [-EnhancedEmergencyServiceDisclaimer ] + [-Description ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -34,7 +34,24 @@ This cmdlet modifies an existing Teams Emergency Calling policy. Emergency calli Set-CsTeamsEmergencyCallingPolicy -Identity "TestECP" -NotificationGroup "123@contoso.com;567@contoso.com" ``` -This example modifies an existing policy instance with identity TestECP. +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 @@ -69,9 +86,6 @@ Accept wildcard characters: False ``` ### -ExtendedNotifications - -**Note**: The use of extended notifications and this parameter is currently not supported. - 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. @@ -135,7 +149,7 @@ 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. +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 @@ -198,7 +212,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 @@ -208,12 +222,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-CsTeamsEmergencyCallingPolicy](New-CsTeamsEmergencyCallingPolicy.md) +[New-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsemergencycallingpolicy) -[Get-CsTeamsEmergencyCallingPolicy](Get-CsTeamsEmergencyCallingPolicy.md) +[Get-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsemergencycallingpolicy) -[Remove-CsTeamsEmergencyCallingPolicy](Remove-CsTeamsEmergencyCallingPolicy.md) +[Remove-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsemergencycallingpolicy) -[Grant-CsTeamsEmergencyCallingPolicy](Grant-CsTeamsEmergencyCallingPolicy.md) +[Grant-CsTeamsEmergencyCallingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsemergencycallingpolicy) -[New-CsTeamsEmergencyCallingExtendedNotification](New-CsTeamsEmergencyCallingExtendedNotification.md) +[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 e23bd0b0a1..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 --- @@ -35,7 +35,6 @@ 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. @@ -47,19 +46,17 @@ PS C:\> Set-CsTeamsEnhancedEncryptionPolicy -Identity "ContosoPartnerTeamsEnhanc 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" +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". ## PARAMETERS @@ -67,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 @@ -115,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 @@ -200,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 fce364668b..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 @@ -14,11 +16,12 @@ This cmdlet allows you to configure options for customizing Teams events experie ``` Set-CsTeamsEventsPolicy [-AllowWebinars ] [-EventAccessType ] [-AllowTownhalls ] - [-AllowEmailEditing ] [-AllowedQuestionTypesInRegistrationForm ] + [-TownhallEventAttendeeAccess ] [-AllowEmailEditing ] [-AllowedQuestionTypesInRegistrationForm ] [-AllowEventIntegrations ] [-AllowedWebinarTypesForRecordingPublish ] [-AllowedTownhallTypesForRecordingPublish ] [-TownhallChatExperience ] [-Description ] - [-UseMicrosoftECDN ] - [-Identity] [-Force] [-WhatIf] [-Confirm] [] + [-RecordingForTownhall ] [-RecordingForWebinar ] + [-TranscriptionForTownhall ] [-TranscriptionForWebinar ] + [-UseMicrosoftECDN ] [-BroadcastPremiumApps ] ``` ## DESCRIPTION @@ -41,7 +44,6 @@ Possible values are: - **Enabled**: Enables creating webinars. - **Disabled**: Disables creating webinars. - ```yaml Type: String Parameter Sets: (All) @@ -57,7 +59,6 @@ Accept wildcard characters: False ### -Description Enables administrators to provide explanatory text to accompany a Teams Events policy. - ```yaml Type: String Parameter Sets: (All) @@ -71,10 +72,10 @@ Accept wildcard characters: False ``` ### -UseMicrosoftECDN -This setting governs whether the global 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. +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 +Type: Boolean Parameter Sets: (All) Aliases: @@ -91,7 +92,6 @@ Possible values are: - **Enabled**: Enables creating town halls. - **Disabled**: Disables creating town halls. - ```yaml Type: String Parameter Sets: (All) @@ -104,10 +104,27 @@ 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) @@ -126,7 +143,6 @@ Possible values are: - **Enabled**: Enables editing of communication emails. - **Disabled**: Disables editing of communication emails. - ```yaml Type: String Parameter Sets: (All) @@ -157,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) @@ -171,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) @@ -192,7 +210,6 @@ Accept wildcard characters: False ### -Identity Unique identifier assigned to the Teams Events policy. - ```yaml Type: String Parameter Sets: (All) @@ -247,7 +264,6 @@ This setting describes how IT admins can control which types of webinar attendee Possible values are: None, InviteOnly, EveryoneInCompanyIncludingGuests, Everyone. - ```yaml Type: String Parameter Sets: (All) @@ -295,6 +311,101 @@ 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. @@ -329,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 @@ -337,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 80% rename from skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md rename to teams/teams-ps/teams/Set-CsTeamsGuestMessagingConfiguration.md index 768cc13f21..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 ] - [-AllowUserDeleteChat ] [-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 ] - [-AllowUserDeleteChat ] [-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. @@ -269,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/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md b/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md similarity index 85% rename from skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md index 0017490a92..033a024718 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBrandingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingBrandingPolicy.md @@ -1,14 +1,14 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsmeetingbrandingpolicy +online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsmeetingbrandingpolicy schema: 2.0.0 title: Set-CsTeamsMeetingBrandingPolicy -author: szymonkatraMSFT -ms.author: szymonkatra +author: serdarsoysal +ms.author: serdars ms.reviewer: manager: stanlythomas -applicable: Skype for Business Online +applicable: Microsoft Teams --- # Set-CsTeamsMeetingBrandingPolicy @@ -41,7 +41,7 @@ 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`. +In this example, the commands will change the brand accent color of the theme inside the `demo branding` meeting branding policy to `#FF0000` ## PARAMETERS @@ -160,7 +160,7 @@ Suppresses any confirmation prompts that would otherwise be displayed before mak ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -187,18 +187,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). +## INPUTS + +## OUTPUTS + ## NOTES Available in Teams PowerShell Module 4.9.3 and later. ## RELATED LINKS -[Get-CsTeamsMeetingBrandingPolicy](Get-CsTeamsMeetingBrandingPolicy.md) +[Get-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingbrandingpolicy) -[Grant-CsTeamsMeetingBrandingPolicy](Grant-CsTeamsMeetingBrandingPolicy.md) +[Grant-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamsmeetingbrandingpolicy) -[New-CsTeamsMeetingBrandingPolicy](New-CsTeamsMeetingBrandingPolicy.md) +[New-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingbrandingpolicy) -[Remove-CsTeamsMeetingBrandingPolicy](Remove-CsTeamsMeetingBrandingPolicy.md) +[Remove-CsTeamsMeetingBrandingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingbrandingpolicy) -[Set-CsTeamsMeetingBrandingPolicy](Set-CsTeamsMeetingBrandingPolicy.md) \ No newline at end of file +[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 56% rename from skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsMeetingPolicy.md index 5dbcd204af..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,28 +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 ] [-AllowedStreamingMediaInput ] [-AutomaticallyStartCopilot ] [-Copilot ] -[-AllowWatermarkForScreenSharing ] [-AllowWatermarkForCameraVideo ] [-AllowLocalRecording ] [-ExternalMeetingJoin ] [-CopyRestriction ] [-VoiceIsolation ] -[-ContentSharingInExternalMeetings ] -[-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 @@ -60,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 @@ -78,18 +163,57 @@ 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 -### -AutomaticallyStartCopilot +### -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 +``` -This policy gives admins the ability to auto-start Copilot. +### -AIInterpreter +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. + +Enables the user to use the AI Interpreter related features + +Possible values: + +- Disabled +- Enabled ```yaml Type: String Parameter Sets: (All) Aliases: +Applicable: Microsoft Teams + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowAnnotations + +This setting will allow admins to choose which users will be able to use the Annotation feature. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -98,12 +222,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Copilot +### -AllowAnonymousUsersToDialOut -This policy gives admins the ability to choose if Copilot will be enabled with a persisted transcript or a non-persisted transcript. +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: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -115,7 +239,6 @@ Accept wildcard characters: False ``` ### -AllowAnonymousUsersToJoinMeeting - > [!NOTE] > The experience for users is dependent on both the value of -DisableAnonymousJoin (the old tenant-wide setting) and -AllowAnonymousUsersToJoinMeeting (the new per-organizer policy). Please check for details. @@ -147,29 +270,30 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowAvatarsInGallery -### -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. - -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. +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: 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. +### -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] -> This only restricts from scheduling and not from joining a meeting scheduled by another user. +> 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 @@ -183,23 +307,28 @@ 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. +### -AllowCartCaptionsScheduling +Determines whether a user can add a URL for captions from a Communications Access Real-Time Translation (CART) captioner for providing real time captions in meetings. +Possible values are: + +- **EnabledUserOverride**, CART captions is available by default but a user can disable. +- **DisabledUserOverride**, if you would like users to be able to use CART captions in meetings but by default it is disabled. +- **Disabled**, if you'd like to not allow CART captions in meeting. ```yaml -Type: 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 ``` -### -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. +### -AllowBreakoutRooms +Set to true to enable Breakout Rooms, set to false to disable the Breakout Rooms functionality. ```yaml Type: Boolean @@ -208,13 +337,16 @@ 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. +### -AllowChannelMeetingScheduling +Determines whether a user can schedule channel meetings. Set this to TRUE to allow a user to schedule channel meetings. Set this to FALSE to prohibit the user from scheduling channel meetings. + +> [!NOTE] +> This only restricts from scheduling and not from joining a meeting scheduled by another user. ```yaml Type: Boolean @@ -228,8 +360,8 @@ 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. +### -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 @@ -243,8 +375,9 @@ 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. +### -AllowDocumentCollaboration + +This setting will allow admins to choose which users will be able to use the Document Collaboration feature. ```yaml Type: String @@ -258,8 +391,14 @@ 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. +### -AllowEngagementReport +Determines whether meeting organizers are allowed to download the attendee engagement report. Possible values are: + +- Enabled: allow the meeting organizer to download the report. +- Disabled: disable attendee report generation and prohibit meeting organizer from downloading it. +- ForceEnabled: enable attendee report generation and prohibit meeting organizer from disabling it. + +If set to Enabled or ForceEnabled, only meeting organizers and co-organizers will get a link to download the report in Teams. Regular attendees will have no access to it. ```yaml Type: String @@ -273,11 +412,12 @@ 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. +### -AllowExternalNonTrustedMeetingChat + +This field controls whether a user is allowed to chat in external meetings with users from non trusted organizations. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -288,45 +428,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCartCaptionsScheduling -Determines whether a user can add a URL for captions from a Communicatons Access Real-Time Translation (CART) captioner for providing real time captions in meetings. -Possible values are: -- **EnabledUserOverride**, CART captions is available by default but a user can disable. -- **DisabledUserOverride**, if you would like users to be able to use CART captions in meetings but by default it is disabled. -- **Disabled**, if you'd like to not allow CART captions in meeting. +### -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: 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 ``` -### -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. +### -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: 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 ``` -### -AllowLocalRecording -This parameter is reserved for internal Microsoft use. +### -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 @@ -335,13 +469,13 @@ Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMeetNow -Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc meetings. Set this to FALSE to prohibit the user from starting ad-hoc meetings. +### -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 @@ -355,8 +489,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. +### -AllowLocalRecording +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -370,8 +504,10 @@ 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. +### -AllowMeetingCoach +This setting will allow admins to allow users the option of turning on Meeting Coach during meetings, which provides users with private personalized feedback on their communication and inclusivity. + If set to True, then users will see and be able to click the option for turning on Meeting Coach during calls. + If set to False, then users will not have the option to turn on Meeting Coach during calls. ```yaml Type: Boolean @@ -385,8 +521,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. +### -AllowMeetingReactions +Set to false to disable Meeting Reactions. ```yaml Type: Boolean @@ -395,16 +531,18 @@ Aliases: Required: False Position: Named -Default value: None +Default value: True 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. +### -AllowMeetingRegistration +Controls if a user can create a webinar meeting. The default value is True. -> [!NOTE] -> This only restricts from scheduling and not from joining a meeting scheduled by another user. +Possible values: + +- True +- False ```yaml Type: Boolean @@ -413,13 +551,13 @@ Aliases: Required: False Position: Named -Default value: None +Default value: True 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. +### -AllowMeetNow +Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc meetings. Set this to FALSE to prohibit the user from starting ad-hoc meetings. ```yaml Type: Boolean @@ -433,23 +571,22 @@ 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. +### -AllowNetworkConfigurationSettingsLookup +Determines whether network configuration setting lookup can be made for users who are not Enterprise Voice enabled. It is used to enable Network Roaming policy. ```yaml Type: Boolean Parameter Sets: (All) Aliases: - Required: False Position: Named -Default value: None +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. +### -AllowNDIStreaming +This parameter enables the use of NDI technology to capture and deliver broadcast-quality audio and video over your network. ```yaml Type: Boolean @@ -463,38 +600,28 @@ 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). +### -AllowOrganizersToOverrideLobbySettings +This parameter has been deprecated and currently has no effect. ```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 ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -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: cf +Aliases: Required: False Position: Named @@ -503,12 +630,11 @@ 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. +### -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: String +Type: Boolean Parameter Sets: (All) Aliases: @@ -519,11 +645,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. +### -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: @@ -534,26 +660,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specify the name of the policy being created. +### -AllowPrivateMeetNow +This setting controls whether a user can start an ad hoc private meeting. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: Required: False -Position: 1 +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. +### -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: UInt32 +Type: Boolean Parameter Sets: (All) Aliases: @@ -564,11 +693,11 @@ 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. +### -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: @@ -579,37 +708,28 @@ 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. +### -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: 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. +### -AllowScreenContentDigitization +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -618,8 +738,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. +### -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 @@ -633,8 +753,9 @@ 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. +### -AllowTasksFromTranscript + +This policy setting allows for the extraction of AI-Assisted Action Items/Tasks from the Meeting Transcript. ```yaml Type: String @@ -648,8 +769,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPrivateMeetNow -This setting controls whether a user can start an ad hoc private meeting. +### -AllowTrackingInReport +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean @@ -663,12 +784,452 @@ 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. +### -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 parameter is temporarily disabled. +> 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 @@ -682,8 +1243,12 @@ 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. +### -EnrollUserOverride +Turn on/off Biometric enrollment +Possible values are: + +- Disabled +- Enabled ```yaml Type: String @@ -692,16 +1257,101 @@ Aliases: Required: False Position: Named -Default value: TeamsAndSfb +Default value: Disabled 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. +### -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 @@ -730,13 +1380,32 @@ 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: +### -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: -- 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. +- **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 @@ -750,13 +1419,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEngagementReport -Determines whether meeting organizers are allowed to download the attendee engagement report. Possible values are: +### -LobbyChat -- Enabled: allow the meeting organizer to download the report. -- Disabled: disable attendee report generation and prohibit meeting organizer from downloading it. +>[!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. -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 are: + +- Enabled +- Disabled ```yaml Type: String @@ -770,11 +1443,11 @@ 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. +### -MediaBitRateKb +Determines the media bit rate for audio/video/app sharing transmissions in meetings. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) Aliases: @@ -785,14 +1458,12 @@ 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. +### -MeetingChatEnabledType +Specifies if users will be able to chat in meetings. Possible values are: Disabled, Enabled, and EnabledExceptAnonymous. -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. +> [!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 @@ -806,72 +1477,79 @@ 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. +### -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. -```yaml -Type: Enum -Position: Named -Default value: AllFilters -Accept pipeline input: False -Accept wildcard characters: False -``` +> [!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). -### -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. +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 +Type: String Parameter Sets: (All) Aliases: +Applicable: Microsoft Teams 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. +### -NewMeetingRecordingExpirationDays +Specifies the number of days before meeting recordings will expire and move to the recycle bin. Value can be from 1 to 99,999 days. Value can also be -1 to set meeting recordings to never expire. + +> [!NOTE] +> You may opt to set Meeting Recordings to never expire by entering the value -1. ```yaml -Type: Boolean +Type: Int32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -NoiseSuppressionForDialInParticipants -### -AllowUserToJoinExternalMeeting -Currently, this parameter has no effect. +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. -Possible values are: -- Enabled -- FederatedOnly +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: Disabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnrollUserOverride -Possible values are: -- Disabled -- Enabled +### -ParticipantNameChange + +This setting will enable Tenant Admins to turn on/off participant renaming feature. + +Possible Values: +Enabled: Turns on the Participant Renaming feature. +Disabled: Turns off the Participant Renaming feature. ```yaml Type: String @@ -880,20 +1558,13 @@ Aliases: Required: False Position: Named -Default value: Disabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StreamingAttendeeMode - -Controls if Teams uses overflow capability once a meeting reaches its capacity (1,000 users with full functionality). - -Possible values are: -- Disabled -- Enabled - -Set this to Enabled to allow up to 20,000 extra view-only attendees to join. +### -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 @@ -902,31 +1573,39 @@ Aliases: Required: False Position: Named -Default value: Disabled +Default value: TeamsAndSfb 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. +### -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: 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 ``` -### -TeamsCameraFarEndPTZMode -Possible values are: -- Disabled -- AutoAcceptInTenant -- AutoAcceptAll +### -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 @@ -935,50 +1614,58 @@ Aliases: Required: False Position: Named -Default value: Disabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMeetingReactions -Set to false to disable Meeting Reactions. +### -RoomAttributeUserOverride +Possible values: + +- Off +- Distinguish +- Attribute ```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 ``` -### -AllowMeetingRegistration -Controls if a user can create a webinar meeting. The default value is True. +### -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: -- True -- False +> +> - 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: 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. +### -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: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -989,11 +1676,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTrackingInReport -This parameter is reserved for internal Microsoft use. +### -SmsNotifications +Participants can sign up for text message meeting reminders. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: @@ -1004,12 +1691,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RoomAttributeUserOverride +### -SpeakerAttributionMode +Determines if users are identified in transcriptions and if they can change the value of the _Automatically identify me in meeting captions and transcripts_ setting. + Possible values: -- Off -- Distinguish -- Attribute +- **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 @@ -1023,11 +1713,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpeakerAttributionMode -Possible values: +### -StreamingAttendeeMode + +Controls if Teams uses overflow capability once a meeting reaches its capacity (1,000 users with full functionality). + +Possible values are: -- EnabledUserOverride - Disabled +- Enabled + +Set this to Enabled to allow up to 20,000 extra view-only attendees to join. ```yaml Type: String @@ -1036,18 +1731,17 @@ Aliases: Required: False Position: Named -Default value: None +Default value: Disabled 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: +### -TeamsCameraFarEndPTZMode +Possible values are: -- Everyone -- EveryoneInCompany +- Disabled +- AutoAcceptInTenant +- AutoAcceptAll ```yaml Type: String @@ -1056,18 +1750,24 @@ Aliases: Required: False Position: Named -Default value: Everyone +Default value: Disabled 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. +### -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` -NOTE: You may opt to set Meeting Recordings to never expire by entering the value -1. +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: Int32 +Type: Guid Parameter Sets: (All) Aliases: @@ -1078,18 +1778,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). +### -UsersCanAdmitFromLobby -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. +This policy controls who can admit from the lobby. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named @@ -1098,13 +1794,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ChannelRecordingDownload -Controls how channel meeting recordings are saved, permissioned, and who can download them. - -Possible values: +### -VideoFiltersMode +Determines the background effects that a user can configure in the Teams client. Possible values are: -- 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. +- NoFilters: No filters are available. +- BlurOnly: Background blur is the only option available (requires a processor with AVX2 support, see [Hardware requirements for Microsoft Teams](https://learn.microsoft.com/microsoftteams/hardware-requirements-for-the-teams-app) for more information). +- BlurAndDefaultBackgrounds: Background blur and a list of pre-selected images are available. +- AllFilters: All filters are available, including custom images. ```yaml Type: String @@ -1113,29 +1809,38 @@ Aliases: Required: False Position: Named -Default value: Allow +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNetworkConfigurationSettingsLookup -Determines whether network configuration setting lookup can be made for users who are not Enterprise Voice enabled. It is used to enable Network Roaming policy. +### -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: 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). +### -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: -Possible values are: - Disabled - Enabled @@ -1143,20 +1848,18 @@ Possible values are: 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 ``` -### -AllowedStreamingMediaInput -Enables the use of RTMP-In in Teams meetings. +### -WatermarkForAnonymousUsers -Possible values are: -- \ -- RTMP +Determines the meeting experience and watermark content of an anonymous user. ```yaml Type: String @@ -1170,59 +1873,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForScreenSharing -This setting allows scheduling meetings with watermarking for screen sharing enabled. +### -WatermarkForCameraVideoOpacity + +Allows the transparency of watermark to be customizable. ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWatermarkForCameraVideo -This setting allows scheduling meetings with watermarking for video enabled. +### -WatermarkForCameraVideoPattern + +Allows the pattern design of watermark to be customizable. ```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 ``` -### -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. +### -WatermarkForScreenSharingOpacity + +Allows the transparency of watermark to be customizable. ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: TRUE +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -WatermarkForScreenSharingPattern -### -ExternalMeetingJoin -Determines whether the user is allowed to join external meetings. - -Possible values are: -- EnabledForAnyone -- EnabledForTrustedOrgs -- Disabled +Allows the pattern design of watermark to be customizable. ```yaml Type: String @@ -1231,17 +1932,17 @@ Aliases: Required: False Position: Named -Default value: EnabledForAnyone +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. +### -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 are: -- Enabled -- EnabledWithTranscript +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 @@ -1250,56 +1951,77 @@ Aliases: Required: False Position: Named -Default value: EnabledWithTranscript +Default value: UsersAllowedToByPassTheLobby 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.* +### -RealTimeText +>[!NOTE] +>This feature has not been released yet and will have no changes if it is enabled or disabled. -This setting gives admins the ability to auto-start Copilot. +Allows users to use real time text during a meeting, allowing them to communicate by typing their messages in real time. -Possible values are: -- Enabled -- Disabled +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: Disabled +Default value: Enabled 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. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. -Possible values are: -- Enabled (default) -- Disabled +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhoCanRegister +Controls the attendees who can attend a webinar meeting. The default is Everyone, meaning that everyone can register. If you want to restrict registration to internal accounts set the value to 'EveryoneInCompany'. + +Possible values: + +- Everyone +- EveryoneInCompany ```yaml Type: String Parameter Sets: (All) Aliases: + Required: False Position: Named -Default value: 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 index 13456eaa57..e9a319c5d3 100644 --- a/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMeetingTemplatePermissionPolicy.md @@ -62,7 +62,7 @@ Accept wildcard characters: False ### -HiddenMeetingTemplates The updated list of meeting template IDs to hide. -The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](New-CsTeamsHiddenMeetingTemplate.yml). +The HiddenMeetingTemplate objects are created with [New-CsTeamsHiddenMeetingTemplate](https://learn.microsoft.com/powershell/module/teams/new-csteamshiddenmeetingtemplate). ```yaml Type: HiddenMeetingTemplate[] @@ -95,11 +95,17 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +## OUTPUTS + +## NOTES + ## RELATED LINKS -[Get-CsTeamsMeetingTemplatePermissionPolicy](Get-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Get-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsmeetingtemplatepermissionpolicy) -[New-CsTeamsMeetingTemplatePermissionPolicy](New-CsTeamsMeetingTemplatePermissionPolicy.yml) +[New-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsmeetingtemplatepermissionpolicy) -[Remove-CsTeamsMeetingTemplatePermissionPolicy](Remove-CsTeamsMeetingTemplatePermissionPolicy.yml) +[Remove-CsTeamsMeetingTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsmeetingtemplatepermissionpolicy) -[Grant-CsTeamsMeetingTemplatePermissionPolicy](Grant-CsTeamsMeetingTemplatePermissionPolicy.yml) \ No newline at end of file +[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 54% rename from skype/skype-ps/skype/Set-CsTeamsMessagingPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsMessagingPolicy.md index 3bda676550..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,28 +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] ] - [-CreateCustomEmojis ] [-DeleteCustomEmojis ] +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] ] [-CreateCustomEmojis ] [-DeleteCustomEmojis ] [-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 @@ -62,11 +129,43 @@ 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 -### -CreateCustomEmojis -This setting enables the creation of custom emojis and reactions within an organization for the specified policy users. +### -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 @@ -80,8 +179,72 @@ 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. +### -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 @@ -97,7 +260,40 @@ 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 @@ -156,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 @@ -171,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 @@ -201,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. @@ -216,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. @@ -292,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 @@ -340,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. @@ -355,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: @@ -370,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: @@ -385,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 @@ -400,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: @@ -450,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. @@ -470,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 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ChatPermissionRole -Determines the Supervised Chat role of the user. Set this to Full to allow the user to supervise chats. Supervisors have the ability to initiate chats with and invite any user within the enviornment. Set this to Limited to allow the user to initiate conversations with Full and Limited permissioned users, but not Restricted. Set this to Restricted to block chat creation with anyone other than Full permissioned users. - -```yaml -Type: String -Position: Named -Default value: Restricted -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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 86% rename from skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md rename to teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md index 792c025ca6..483c23e72a 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMobilityPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsMobilityPolicy.md @@ -1,181 +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] ] [-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. - -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 -``` - -### -MobileDialerPreference -Determines the mobile dialer preference, possible values are: Teams, Native, UserOverride. -For more information, see [Manage user incoming calling policies](/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 +--- +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 95% rename from skype/skype-ps/skype/Set-CsTeamsPinnedApp.md rename to teams/teams-ps/teams/Set-CsTeamsPinnedApp.md index d73b95242c..fac26286e2 100644 --- a/skype/skype-ps/skype/Set-CsTeamsPinnedApp.md +++ b/teams/teams-ps/teams/Set-CsTeamsPinnedApp.md @@ -1,13 +1,13 @@ --- 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 @@ -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 index a456477844..31c805cfbb 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsSharedCallingRoutingPolicy.md @@ -3,11 +3,13 @@ external help file: MicrosoftTeams-help.xml Module Name: MicrosoftTeams online version: https://learn.microsoft.com/powershell/module/teams/set-csteamssharedcallingroutingpolicy applicable: Microsoft Teams -author: jenstrier -ms.author: jenstr -ms.reviewer: -manager: +title: Set-CsTeamsSharedCallingRoutingPolicy schema: 2.0.0 +author: serdarsoysal +ms.author: serdars +ms.reviewer: +manager: + --- # Set-CsTeamsSharedCallingRoutingPolicy @@ -44,7 +46,7 @@ The command shown in Example 1 removes the emergency callback number +1425555667 ## PARAMETERS ### -Identity -Unique identifier of the Teams shared calling routing policy to be created. +Unique identifier of the Teams shared calling routing policy to be created. ```yaml Type: String @@ -101,10 +103,10 @@ The Identity of the resource account. Can only be specified using the Identity o 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](Set-CsPhoneNumberAssignment.md) and the -LocationId parameter to set the location. +- 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. +The same resource account can be used in multiple shared calling policy instances. ```yaml Type: String @@ -175,21 +177,21 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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](/microsoftteams/phone-reference/manage-numbers/contact-tns-service-desk). +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. +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](/microsoftteams/phone-reference/manage-numbers/contact-tns-service-desk). +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](New-CsTeamsSharedCallingRoutingPolicy.md) +[New-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamssharedcallingroutingpolicy) -[Grant-CsTeamsSharedCallingRoutingPolicy](Grant-CsTeamsSharedCallingRoutingPolicy.md) +[Grant-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/grant-csteamssharedcallingroutingpolicy) -[Remove-CsTeamsSharedCallingRoutingPolicy](Remove-CsTeamsSharedCallingRoutingPolicy.md) +[Remove-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamssharedcallingroutingpolicy) -[Get-CsTeamsSharedCallingRoutingPolicy](Get-CsTeamsSharedCallingRoutingPolicy.md) +[Get-CsTeamsSharedCallingRoutingPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamssharedcallingroutingpolicy) -[Set-CsPhoneNumberAssignment](Set-CsPhoneNumberAssignment.md) +[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 index 2761b3d3b6..dd1eca6bb1 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnection.md @@ -2,8 +2,8 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: Set-CsTeamsShiftsConnection -author: shane-malone -ms.author: shanemalone +author: serdarsoysal +ms.author: serdars manager: valk online version: https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection schema: 2.0.0 @@ -17,23 +17,33 @@ This cmdlet sets an existing workforce management (WFM) connection. ## SYNTAX ### Set (Default) -``` -Set-CsTeamsShiftsConnection -ConnectionId -Body [-Authorization ] [-IfMatch ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Set-CsTeamsShiftsConnection -ConnectionId -Body [-Authorization ] [-IfMatch ] + [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] +[-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### SetExpanded -``` -Set-CsTeamsShiftsConnection -ConnectionId [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Set-CsTeamsShiftsConnection -ConnectionId [-Authorization ] [-IfMatch ] [-ConnectorId ] + [-ConnectorSpecificSettings ] [-Etag ] [-Name ] + [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] +[-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### SetViaIdentityExpanded -``` -Set-CsTeamsShiftsConnection -InputObject [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Set-CsTeamsShiftsConnection -InputObject [-Authorization ] [-IfMatch ] [-ConnectorId ] + [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-State ] [-Break] + [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### SetViaIdentity -``` -Set-CsTeamsShiftsConnection -InputObject -Body [-Authorization ] [-IfMatch ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Set-CsTeamsShiftsConnection -InputObject -Body [-Authorization ] +[-IfMatch ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -204,7 +214,7 @@ Accept wildcard characters: False ``` ### -ConnectionId -The WFM connection ID for the instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). +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 @@ -384,6 +394,51 @@ 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). @@ -403,10 +458,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) -[New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) -[Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) +[Update-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection) -[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) \ No newline at end of file +[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 8e5a8e7ca6..eb62460fc0 100644 --- a/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Set-CsTeamsShiftsConnectionInstance.md @@ -17,22 +17,34 @@ 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 [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```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 [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch [-ConnectionId ] [-ConnectorAdminEmail ] + [-DesignatedActorId ] [-Etag ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] +[-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] + [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] + [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### SetViaIdentity -``` +```powershell Set-CsTeamsShiftsConnectionInstance -InputObject -IfMatch -Body [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` @@ -112,7 +124,7 @@ In case of error, we can capture the error response as following: ## PARAMETERS ### -Body -The request body +The request body ```yaml Type: IConnectorInstanceRequest @@ -182,7 +194,7 @@ Accept wildcard characters: False ``` ### -ConnectionId -Gets or sets the WFM connection ID for the new instance. This can be retrieved by running [Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md). +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 @@ -490,6 +502,21 @@ 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). @@ -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 a55bbb2b29..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 --- @@ -13,15 +14,16 @@ This cmdlet allows you to set or update properties of a TeamsShiftPolicy instanc ## SYNTAX -``` -Set-CsTeamsShiftsPolicy [[-Identity] ] [-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 and Teams off shift warning message-specific settings (ShiftNoticeMessageType, ShiftNoticeMessageCustom, ShiftNoticeFrequency, AccessGracePeriodMinutes). - - ## EXAMPLES ### Example 1 @@ -30,7 +32,6 @@ PS C:\> Set-CsTeamsShiftsPolicy -Identity OffShiftAccess_WarningMessage1_AlwaysS ``` 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 ### -Identity @@ -53,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) @@ -67,7 +67,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. @@ -78,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) @@ -124,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) @@ -152,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 @@ -163,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 index df518de608..2163f1d2f1 100644 --- a/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md +++ b/teams/teams-ps/teams/Set-CsTeamsSipDevicesConfiguration.md @@ -17,18 +17,17 @@ This cmdlet is used to manage the organization-wide Teams SIP devices configurat ## SYNTAX ```powershell -Set-CsTeamsSipDevicesConfiguration - [-BulkSignIn ] - [-WhatIf] - [-Confirm] - [] +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 Global Administrator, Teams Administrator, or Teams Communication Administrator. +To execute the cmdlet, you need to hold a role within your organization such as Teams Administrator or Teams Communication Administrator. ## EXAMPLES @@ -37,6 +36,7 @@ To execute the cmdlet, you need to hold a role within your organization such as ```powershell Set-CsTeamsSipDevicesConfiguration -BulkSignIn "Enabled" ``` + In this example, Bulk SignIn is set to Enabled across the organization. ### Example 2 @@ -44,6 +44,7 @@ In this example, Bulk SignIn is set to Enabled across the organization. ```powershell Set-CsTeamsSipDevicesConfiguration -BulkSignIn "Disabled" ``` + In this example, Bulk SignIn is set to Disabled across the organization. ## PARAMETERS @@ -59,9 +60,46 @@ 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](Get-CsTeamsSipDevicesConfiguration.md) +[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 index 28317a8406..8aa49764df 100644 --- a/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsTemplatePermissionPolicy.md @@ -5,7 +5,7 @@ online version: https://learn.microsoft.com/powershell/module/teams/set-csteamst title: Set-CsTeamsTemplatePermissionPolicy author: yishuaihuang4 ms.author: yishuaihuang -ms.reviewer: +ms.reviewer: manager: weiliu2 schema: 2.0.0 --- @@ -33,7 +33,7 @@ Updates any of the properties of an existing instance of the TeamsTemplatePermis 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 +PS >Set-CsTeamsTemplatePermissionPolicy -Identity Global -HiddenTemplates $HiddenList ``` Updates the hidden templates array. @@ -89,7 +89,7 @@ Accept wildcard characters: False ### -HiddenTemplates The updated list of Teams template IDs to hide. -The HiddenTemplate objects are created with [New-CsTeamsHiddenTemplate](New-CsTeamsHiddenTemplate.md). +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] @@ -148,8 +148,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsTemplatePermissionPolicy](Get-CsTeamsTemplatePermissionPolicy.md) +[Get-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamstemplatepermissionpolicy) -[New-CsTeamsTemplatePermissionPolicy](New-CsTeamsTemplatePermissionPolicy.md) +[New-CsTeamsTemplatePermissionPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamstemplatepermissionpolicy) -[Remove-CsTeamsTemplatePermissionPolicy](Remove-CsTeamsTemplatePermissionPolicy.md) +[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 index 20ca5203f0..363ba6ac2f 100644 --- a/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md +++ b/teams/teams-ps/teams/Set-CsTeamsVirtualAppointmentsPolicy.md @@ -1,11 +1,12 @@ --- external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml Module Name: MicrosoftTeams -online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsvirtualappointmentspolicy +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 -author: emmanuelrocha001 --- # Set-CsTeamsVirtualAppointmentsPolicy @@ -125,10 +126,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md) +[Get-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/get-csteamsvirtualappointmentspolicy) -[New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md) +[New-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/new-csteamsvirtualappointmentspolicy) -[Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md) +[Remove-CsTeamsVirtualAppointmentsPolicy](https://learn.microsoft.com/powershell/module/teams/remove-csteamsvirtualappointmentspolicy) -[Grant-CsTeamsVirtualAppointmentsPolicy](Grant-CsTeamsVirtualAppointmentsPolicy.md) +[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 08fc5cd060..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,37 +15,37 @@ Modifies an existing Teams voice applications policy. ## SYNTAX ``` -Set-CsTeamsVoiceApplicationsPolicy +Set-CsTeamsVoiceApplicationsPolicy [-AllowAutoAttendantBusinessHoursGreetingChange ] [-AllowAutoAttendantAfterHoursGreetingChange ] [-AllowAutoAttendantHolidayGreetingChange ] [-AllowAutoAttendantBusinessHoursChange ] - [-AllowAutoAttendantHolidaysChange ] - [-AllowAutoAttendantTimeZoneChange ] - [-AllowAutoAttendantLanguageChange ] - [-AllowAutoAttendantBusinessHoursRoutingChange ] + [-AllowAutoAttendantHolidaysChange ] + [-AllowAutoAttendantTimeZoneChange ] + [-AllowAutoAttendantLanguageChange ] + [-AllowAutoAttendantBusinessHoursRoutingChange ] [-AllowAutoAttendantAfterHoursRoutingChange ] - [-AllowAutoAttendantHolidayRoutingChange ] - - [-AllowCallQueueWelcomeGreetingChange ] + [-AllowAutoAttendantHolidayRoutingChange ] + + [-AllowCallQueueWelcomeGreetingChange ] [-AllowCallQueueMusicOnHoldChange ] [-AllowCallQueueOverflowSharedVoicemailGreetingChange ] [-AllowCallQueueTimeoutSharedVoicemailGreetingChange ] [-AllowCallQueueNoAgentSharedVoicemailGreetingChange ] - [-AllowCallQueueLanguageChange ] - [-AllowCallQueueMembershipChange ] - [-AllowCallQueueConferenceModeChange ] - [-AllowCallQueueRoutingMethodChange ] + [-AllowCallQueueLanguageChange ] + [-AllowCallQueueMembershipChange ] + [-AllowCallQueueConferenceModeChange ] + [-AllowCallQueueRoutingMethodChange ] [-AllowCallQueuePresenceBasedRoutingChange ] - [-AllowCallQueueOptOutChange ] + [-AllowCallQueueOptOutChange ] [-AllowCallQueueOverflowRoutingChange ] - [-AllowCallQueueTimeoutRoutingChange ] + [-AllowCallQueueTimeoutRoutingChange ] [-AllowCallQueueNoAgentsRoutingChange ] - [-AllowCallQueueAgentOptChange ] - + [-AllowCallQueueAgentOptChange ] + [-CallQueueAgentMonitorMode ] [-CallQueueAgentMonitorNotificationMode ] - + [-RealTimeAutoAttendantMetricsPermission ] [-RealTimeCallQueueMetricsPermission ] [-RealTimeAgentMetricsPermission ] @@ -52,7 +53,7 @@ Set-CsTeamsVoiceApplicationsPolicy [-HistoricalAutoAttendantMetricsPermission ] [-HistoricalCallQueueMetricsPermission ] [-HistoricalAgentMetricsPermission ] - + [[-Identity] ] [-WhatIf] [-Confirm] [] ``` @@ -155,6 +156,8 @@ Accept wildcard characters: False ### -AllowAutoAttendantTimeZoneChange +_This feature is not currently available to authorized users._ + When set to `True`, users affected by the policy will be allowed to change the auto attendant's time zone. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's time zone. ```yaml @@ -171,6 +174,8 @@ Accept wildcard characters: False ### -AllowAutoAttendantLanguageChange +_This feature is not currently available to authorized users._ + When set to `True`, users affected by the policy will be allowed to change the auto attendant's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the auto attendant's language. ```yaml @@ -299,6 +304,8 @@ Accept wildcard characters: False ### -AllowCallQueueNoAgentSharedVoicemailGreetingChange +_This feature is not currently available to authorized users._ + When set to `True`, users affected by the policy will be allowed to change the call queue's no agent shared voicemail greeting. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's no agent shared voicemail greeting. ```yaml @@ -315,6 +322,8 @@ Accept wildcard characters: False ### -AllowCallQueueLanguageChange +_This feature is not currently available to authorized users._ + When set to `True`, users affected by the policy will be allowed to change the call queue's language. When set to `False` (the default value), users affected by the policy won't be allowed to change the call queue's language. ```yaml @@ -461,8 +470,6 @@ Accept wildcard characters: False 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. -Note that the call queue must be configured to allow agents to opt out in order for this option to work. - ```yaml Type: Boolean Parameter Sets: (All) @@ -493,7 +500,7 @@ When set to `Takeover`, users affected by the policy will be allowed to monitor Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -514,7 +521,7 @@ When set to `Agent`, users affected by the policy will be allowed to monitor age Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -530,14 +537,15 @@ 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 `All`, users affected by the policy will receive real-time metrics for all auto attendants in the organization. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAutoAttendantMetricsPermission* set to `All` will not be able to access real-time metrics. ```yaml Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -545,7 +553,7 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - + ### -RealTimeCallQueueMetricsPermission PARAMVALUE: Disabled | AuthorizedOnly | All @@ -553,14 +561,15 @@ PARAMVALUE: Disabled | AuthorizedOnly | All When set to `Disabled` (the default value), users affected by the policy won't receive real-time metrics for call queues. When set to `AuthorizedOnly`, users affected by the policy will receive real-time metrics for call queues they are authorized for. - -When set to `All`, users affected by the policy will receive real-time metrics for all call queues in the organization. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeCallQueueMetricsPermission* set to `All` will not be able to access real-time metrics. ```yaml Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -576,14 +585,15 @@ 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. - -When set to `All`, users affected by the policy will receive real-time metrics for all agents in all call queues in the organization. + +> [!IMPORTANT] +> The `All` option is no longer supported. The parameter will be accepted and saved however any user assigned a policy with *RealTimeAgentMetricsPermission* set to `All` will not be able to access real-time metrics. ```yaml Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -599,14 +609,14 @@ PARAMVALUE: Disabled | AuthorizedOnly | All When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for auto attendants. When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for auto attendants they are authorized for. - + When set to `All`, users affected by the policy will receive historical metrics for all auto attendants in the organization. ```yaml Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -614,7 +624,7 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - + ### -HistoricalCallQueueMetricsPermission PARAMVALUE: Disabled | AuthorizedOnly | All @@ -622,14 +632,14 @@ PARAMVALUE: Disabled | AuthorizedOnly | All When set to `Disabled` (the default value), users affected by the policy won't receive historical metrics for call queues. When set to `AuthorizedOnly`, users affected by the policy will receive historical metrics for call queues they are authorized for. - + When set to `All`, users affected by the policy will receive historical metrics for all call queues in the organization. ```yaml Type: Object Parameter Sets: Dual Aliases: -Applicable: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -645,14 +655,14 @@ 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: Skype for Business Online +applicable: Microsoft Teams Required: False Position: Named @@ -732,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/skype/skype-ps/skype/Set-CsTenantDialPlan.md b/teams/teams-ps/teams/Set-CsTenantDialPlan.md similarity index 88% rename from skype/skype-ps/skype/Set-CsTenantDialPlan.md rename to teams/teams-ps/teams/Set-CsTenantDialPlan.md index aa825c7937..1df48b83dc 100644 --- a/skype/skype-ps/skype/Set-CsTenantDialPlan.md +++ b/teams/teams-ps/teams/Set-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/set-cstenantdialplan +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: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -59,8 +59,8 @@ $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. +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. @@ -89,7 +89,7 @@ Maximum characters is 1040. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -105,7 +105,7 @@ The Identity parameter is a unique identifier that designates the name of the te ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -117,14 +117,14 @@ 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. +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: +Aliases: Applicable: Microsoft Teams Required: False @@ -142,7 +142,7 @@ This string can be up to 49 characters long. Valid characters are alphabetic or ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Applicable: Microsoft Teams Required: False @@ -169,7 +169,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 @@ -181,10 +181,10 @@ The Get-CsTenantDialPlan will still show the external access prefix in the form ## RELATED LINKS -[Grant-CsTenantDialPlan](Grant-CsTenantDialPlan.md) +[Grant-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/grant-cstenantdialplan) -[New-CsTenantDialPlan](New-CsTenantDialPlan.md) +[New-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/new-cstenantdialplan) -[Get-CsTenantDialPlan](Get-CsTenantDialPlan.md) +[Get-CsTenantDialPlan](https://learn.microsoft.com/powershell/module/teams/get-cstenantdialplan) -[Remove-CsTenantDialPlan](Remove-CsTenantDialPlan.md) +[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 64% rename from skype/skype-ps/skype/Set-CsTenantFederationConfiguration.md rename to teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md index 5d32b2b1f7..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 @@ -165,8 +229,8 @@ 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 @@ -182,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 @@ -192,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. @@ -246,7 +294,26 @@ 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 @@ -263,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 @@ -278,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 @@ -299,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 @@ -315,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 @@ -332,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 @@ -359,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 @@ -377,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 @@ -393,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 @@ -410,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 @@ -420,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. @@ -437,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/skype/skype-ps/skype/Set-CsTenantNetworkRegion.md b/teams/teams-ps/teams/Set-CsTenantNetworkRegion.md similarity index 82% rename from skype/skype-ps/skype/Set-CsTenantNetworkRegion.md rename to teams/teams-ps/teams/Set-CsTenantNetworkRegion.md index b51c5d0693..7ec40da511 100644 --- a/skype/skype-ps/skype/Set-CsTenantNetworkRegion.md +++ b/teams/teams-ps/teams/Set-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/set-cstenantnetworkregion +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworkregion applicable: Microsoft Teams title: Set-CsTenantNetworkRegion schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -20,7 +20,7 @@ As an admin, you can use the Teams PowerShell command, Set-CsTenantNetworkRegion ### Identity (Default) ``` Set-CsTenantNetworkRegion [[-Identity] ] [-CentralSite ] [-Description ] - [-NetworkRegionID ] [-WhatIf] [-Confirm] [] + [-NetworkRegionID ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -129,8 +129,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,11 +138,12 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[New-CsTenantNetworkRegion](New-CsTenantNetworkRegion.md) +[New-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworkregion) -[Remove-CsTenantNetworkRegion](Remove-CsTenantNetworkRegion.md) +[Remove-CsTenantNetworkRegion](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworkregion) -[Get-CsTenantNetworkRegion](Get-CsTenantNetworkRegion.md) +[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 86% rename from skype/skype-ps/skype/Set-CsTenantNetworkSite.md rename to teams/teams-ps/teams/Set-CsTenantNetworkSite.md index 90d9a01924..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 +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksite applicable: Microsoft Teams title: Set-CsTenantNetworkSite schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -87,7 +87,7 @@ Accept wildcard characters: False ``` ### -EmergencyCallingPolicy -This parameter is used to assign a custom emergency calling policy to a network site. For more information, see [Assign a custom emergency calling policy to a network site](/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). +This parameter is used to assign a custom emergency calling policy to a network site. For more information, see [Assign a custom emergency calling policy to a network site](https://learn.microsoft.com/microsoftteams/manage-emergency-calling-policies#assign-a-custom-emergency-calling-policy-to-a-network-site). ```yaml Type: String @@ -102,7 +102,7 @@ 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). +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 @@ -207,8 +207,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -217,11 +216,12 @@ For more information, see [about_CommonParameters](https://go.microsoft.com/fwli ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[New-CsTenantNetworkSite](New-CsTenantNetworkSite.md) +[New-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksite) -[Remove-CsTenantNetworkSite](Remove-CsTenantNetworkSite.md) +[Remove-CsTenantNetworkSite](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksite) -[Get-CsTenantNetworkSite](Get-CsTenantNetworkSite.md) +[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 87% rename from skype/skype-ps/skype/Set-CsTenantNetworkSubnet.md rename to teams/teams-ps/teams/Set-CsTenantNetworkSubnet.md index a227b8863d..52e3aea595 100644 --- a/skype/skype-ps/skype/Set-CsTenantNetworkSubnet.md +++ b/teams/teams-ps/teams/Set-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/set-cstenantnetworksubnet +online version: https://learn.microsoft.com/powershell/module/teams/set-cstenantnetworksubnet applicable: Microsoft Teams title: Set-CsTenantNetworkSubnet schema: 2.0.0 manager: bulenteg -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars ms.reviewer: --- @@ -141,8 +141,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,8 +150,8 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ## NOTES ## RELATED LINKS -[New-CsTenantNetworkSubnet](New-CsTenantNetworkSubnet.md) +[New-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/new-cstenantnetworksubnet) -[Remove-CsTenantNetworkSubnet](Remove-CsTenantNetworkSubnet.md) +[Remove-CsTenantNetworkSubnet](https://learn.microsoft.com/powershell/module/teams/remove-cstenantnetworksubnet) -[Get-CsTenantNetworkSubnet](Get-CsTenantNetworkSubnet.md) +[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 1b3d080690..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) @@ -271,7 +270,7 @@ Accept wildcard characters: False The group notification override that will be set on the specified user. The supported values are Ring, Mute and Banner. 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 94% rename from skype/skype-ps/skype/Set-CsVideoInteropServiceProvider.md rename to teams/teams-ps/teams/Set-CsVideoInteropServiceProvider.md index 4c4d43e83c..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 @@ -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 0e8add851b..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 @@ -404,8 +405,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 @@ -415,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 index 37dbcea9ce..81c1a3382e 100644 --- a/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md +++ b/teams/teams-ps/teams/Set-TeamsEnvironmentConfig.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.TeamsCmdlets.PowerShell.Connect.dll-Help.xml Module Name: MicrosoftTeams -online version: +online version: https://learn.microsoft.com/powershell/module/teams/set-teamsenvironmentconfig +title: Set-TeamsEnvironmentConfig schema: 2.0.0 author: VikneshMSFT ms.author: vimohan @@ -24,10 +25,10 @@ Set-TeamsEnvironmentConfig [-EndpointUris ] [-TeamsEnvironmentName ] [-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. For more information about requirements of the Meeting Migration Service (MMS), see [Using the Meeting Migration Service (MMS)](/skypeforbusiness/audio-conferencing-in-office-365/setting-up-the-meeting-migration-service-mms). +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 76% rename from skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md rename to teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md index 64f7df7454..8076e411c3 100644 --- a/skype/skype-ps/skype/Sync-CsOnlineApplicationInstance.md +++ b/teams/teams-ps/teams/Sync-CsOnlineApplicationInstance.md @@ -1,11 +1,11 @@ --- external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/sync-csonlineapplicationinstance +online version: https://learn.microsoft.com/powershell/module/teams/sync-csonlineapplicationinstance applicable: Microsoft Teams title: Sync-CsOnlineApplicationInstance schema: 2.0.0 -author: jenstrier -ms.author: jenstr +author: serdarsoysal +ms.author: serdars manager: naveenv ms.reviewer: --- @@ -13,12 +13,12 @@ ms.reviewer: # Sync-CsOnlineApplicationInstance ## SYNOPSIS -Use the Sync-CsOnlineApplicationInstance cmdlet to sync the application instance from Microsoft Entra ID into Agent Provisioning Service. This is needed because the mapping between application instance and application needs to be stored in Agent Provisioning Service. If an application ID was provided at the creation of the application instance, you need not run this cmdlet. +Use the Sync-CsOnlineApplicationInstance cmdlet to sync the application instance from Microsoft Entra ID into Agent Provisioning Service. This is needed because the mapping between application instance and application needs to be stored in Agent Provisioning Service. If an application ID was provided at the creation of the application instance, you need not run this cmdlet. ## SYNTAX ``` -Sync-CsOnlineApplicationInstance -ObjectId [-CallbackUri ] [-Force] [-ApplicationId ] [-WhatIf] [-Confirm] [] +Sync-CsOnlineApplicationInstance -ObjectId [-CallbackUri ] [-Force] [-ApplicationId ] [-AcsResourceId ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -41,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 @@ -89,6 +88,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AcsResourceId +The ACS Resource ID. The unique identifier assigned to an instance of Azure Communication Services within the Azure cloud infrastructure. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required. @@ -136,7 +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 @@ -146,10 +160,10 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## RELATED LINKS -[Set-CsOnlineApplicationInstance](Set-CsOnlineApplicationInstance.md) +[Set-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/set-csonlineapplicationinstance) -[New-CsOnlineApplicationInstance](New-CsOnlineApplicationInstance.md) +[New-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/new-csonlineapplicationinstance) -[Find-CsOnlineApplicationInstance](Find-CsOnlineApplicationInstance.md) +[Find-CsOnlineApplicationInstance](https://learn.microsoft.com/powershell/module/teams/find-csonlineapplicationinstance) -[Get-CsOnlineApplicationInstance](Get-CsOnlineApplicationInstance.md) +[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 9565d9ee84..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'} ` @@ -126,7 +126,6 @@ isFavoriteByDefault= $true ` > [!Note] > It can take up to 24 hours for Teams users to see a custom template change in the gallery. - ## PARAMETERS ### -App @@ -675,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. @@ -729,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. @@ -804,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 index 302189b7ad..776c82c956 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnection.md @@ -2,8 +2,8 @@ external help file: Microsoft.Teams.ConfigAPI.Cmdlets-help.xml Module Name: MicrosoftTeams title: Update-CsTeamsShiftsConnection -author: shane-malone -ms.author: shanemalone +author: serdarsoysal +ms.author: serdars manager: online version: https://docs.microsoft.com/powershell/module/teams/update-csteamsshiftsconnection schema: 2.0.0 @@ -17,23 +17,33 @@ This cmdlet updates an existing workforce management (WFM) connection. ## SYNTAX ### Update (Default) -``` -Update-CsTeamsShiftsConnection -ConnectionId -Body [-Authorization ] [-IfMatch ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Update-CsTeamsShiftsConnection -ConnectionId -Body [-Authorization ] [-IfMatch ] + [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### UpdateExpanded -``` -Update-CsTeamsShiftsConnection -ConnectionId [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Update-CsTeamsShiftsConnection -ConnectionId [-Authorization ] [-IfMatch ] [-ConnectorId ] + [-ConnectorSpecificSettings ] [-Etag ] [-Name ] + [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] +[-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded -``` -Update-CsTeamsShiftsConnection -InputObject [-Authorization ] [-IfMatch ] [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] [-Name ] [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Update-CsTeamsShiftsConnection -InputObject [-Authorization ] [-IfMatch ] + [-ConnectorId ] [-ConnectorSpecificSettings ] [-Etag ] + [-Name ] [-State ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] + [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentity -``` -Update-CsTeamsShiftsConnection -InputObject -Body [-Authorization ] [-IfMatch ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Update-CsTeamsShiftsConnection -InputObject -Body [-Authorization ] + [-IfMatch ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -319,6 +329,82 @@ 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). @@ -338,10 +424,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-CsTeamsShiftsConnection](Get-CsTeamsShiftsConnection.md) +[Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection) -[New-CsTeamsShiftsConnection](New-CsTeamsShiftsConnection.md) +[New-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/new-csteamsshiftsconnection) -[Set-CsTeamsShiftsConnection](Set-CsTeamsShiftsConnection.md) +[Set-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/set-csteamsshiftsconnection) -[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) +[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 cc12150424..466a0bf1c7 100644 --- a/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md +++ b/teams/teams-ps/teams/Update-CsTeamsShiftsConnectionInstance.md @@ -17,23 +17,37 @@ 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 [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```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 [-ConnectionId ] [-ConnectorAdminEmail ] [-DesignatedActorId ] [-Etag ] [-Name ] [-State ] [-SyncFrequencyInMin ] [-SyncScenarioOfferShiftRequest ] [-SyncScenarioOpenShift ] [-SyncScenarioOpenShiftRequest ] [-SyncScenarioShift ] [-SyncScenarioSwapRequest ] [-SyncScenarioTimeCard ] [-SyncScenarioTimeOff ] [-SyncScenarioTimeOffRequest ] [-SyncScenarioUserShiftPreference ] [-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 ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +```powershell +Update-CsTeamsShiftsConnectionInstance -InputObject -IfMatch -Body + [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -454,6 +468,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectionId +The WFM connection ID for the instance. +This can be retrieved by running [Get-CsTeamsShiftsConnection](https://learn.microsoft.com/powershell/module/teams/get-csteamsshiftsconnection). + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Used to manage concurrency control. It helps ensure that updates to a Shifts connection instance are only applied if the instance has not been modified since it was last retrieved. This is particularly useful in preventing conflicts when multiple administrators might be making changes simultaneously. + +```yaml +Type: String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -473,12 +518,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) -[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) -[Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) \ No newline at end of file +[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 df304d097d..058504f325 100644 --- a/teams/teams-ps/teams/teams.md +++ b/teams/teams-ps/teams/teams.md @@ -12,184 +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}} - -### [Update-CsTeamsShiftsConnectionInstance](Update-CsTeamsShiftsConnectionInstance.md) -This cmdlet updates Shifts connection instance fields. - ### [Set-TeamsEnvironmentConfig](Set-TeamsEnvironmentConfig.md) -This cmdlet sets environment-specific configurations like endpoint URIs and Teams environment in the local machine. - -### [Clear-TeamsEnvironmentConfig](Clear-TeamsEnvironmentConfig.md) -Clears environment-specific configurations from the local machine set by running Set-TeamsEnvironmentConfig. +### [Set-TeamTargetingHierarchy](Set-TeamTargetingHierarchy.md) +### [Start-CsExMeetingMigration](Start-CsExMeetingMigration.md) +### [Sync-CsOnlineApplicationInstance](Sync-CsOnlineApplicationInstance.md) +### [Test-CsEffectiveTenantDialPlan](Test-CsEffectiveTenantDialPlan.md) +### [Test-CsInboundBlockedNumberPattern](Test-CsInboundBlockedNumberPattern.md) +### [Test-CsTeamsShiftsConnectionValidate](Test-CsTeamsShiftsConnectionValidate.md) +### [Test-CsTeamsTranslationRule](Test-CsTeamsTranslationRule.md) +### [Test-CsTeamsUnassignedNumberTreatment](Test-CsTeamsUnassignedNumberTreatment.md) +### [Test-CsVoiceNormalizationRule](Test-CsVoiceNormalizationRule.md) +### [Unregister-CsOnlineDialInConferencingServiceNumber](Unregister-CsOnlineDialInConferencingServiceNumber.md) +### [Update-CsAutoAttendant](Update-CsAutoAttendant.md) +### [Update-CsCustomPolicyPackage](Update-CsCustomPolicyPackage.md) +### [Update-CsTeamsShiftsConnection](Update-CsTeamsShiftsConnection.md) +### [Update-CsTeamsShiftsConnectionInstance](Update-CsTeamsShiftsConnectionInstance.md) +### [Update-CsTeamTemplate](Update-CsTeamTemplate.md) +### [Update-M365UnifiedCustomPendingApp](Update-M365UnifiedCustomPendingApp.md) +### [Update-TeamsAppInstallation](Update-TeamsAppInstallation.md) diff --git a/whiteboard/docfx.json b/whiteboard/docfx.json index 04e4a316af..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", diff --git a/whiteboard/docs-conceptual/overview.md b/whiteboard/docs-conceptual/overview.md index 31e1311b7b..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.